Skip to main content
A newer release of this product is available.

Update an NTP server configuration after validation

Contributors
PDFs

PATCH /cluster/ntp/servers/{server}

Introduced In: 9.7

Updates the configuration of an NTP server used by the ONTAP cluster after validation. Patchable fields are:

  • version

  • key.id

  • authentication_enabled

If authentication_enabled is modified to false, the associated NTP key is removed from the server instance. If authentication_enabled is modified to true, you must provide an NTP key ID in the PATCH body.

  • cluster time-service ntp server modify

Learn more

Parameters

Name Type In Required Description

server

string

path

True

Server address or host name

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Request Body

Name Type Description

_links

_links

authentication_enabled

boolean

Set NTP symmetric authentication on (true) or off (false).

key

ntp_key_reference

server

string

NTP server host name, IPv4, or IPv6 address.

version

string

NTP protocol version for server. Valid versions are 3, 4, or auto.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "authentication_enabled": 1,
  "key": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "id": "10"
  },
  "server": "time.nist.gov",
  "version": "auto"
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

2097163

NTP server address was invalid.

2097164

NTP server address was invalid.

2097165

Could not resolve NTP server hostname.

2097166

NTP server address query returned no valid IP addresses.

2097167

Failed to connect to NTP server.

2097169

NTP server provided was not synchronized.

2097174

NTP server provided had too high of root distance.

2097177

NTP server provided had an invalid stratum.

2097181

NTP server address was invalid.

2097182

NTP server address was invalid.

2097183

NTP symmetric key authentication cannot be used for a node not in a cluster.

2097185

NTP key authentication failed for the provided key.

2097188

An invalid key identifier was provided. Identifiers must be in the range from 1 to 65535.

2097193

An unknown key was provided.

2097194

The field "authentication_enabled" cannot be false when the field NTP key is given.
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

ntp_key_reference

Name Type Description

_links

_links

id

integer

NTP symmetric authentication key identifier or index number (ID). This ID, the type of cryptographic hash, and the cryptographic hash value are all provided by the remote NTP server.

ntp_server

Name Type Description

_links

_links

authentication_enabled

boolean

Set NTP symmetric authentication on (true) or off (false).

key

ntp_key_reference

server

string

NTP server host name, IPv4, or IPv6 address.

version

string

NTP protocol version for server. Valid versions are 3, 4, or auto.
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.