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

Retrieve external NTP time servers

PDFs

GET /cluster/ntp/servers

Introduced In: 9.7

Retrieves the collection of external NTP time servers ONTAP uses for time adjustment and correction.

  • cluster time-service ntp server show

Learn more

Parameters

Name Type In Required Description

authentication_enabled

boolean

query

False

Filter by authentication_enabled

version

string

query

False

Filter by version

server

string

query

False

Filter by server

key.id

integer

query

False

Filter by key.id

  • Max value: 65535

  • Min value: 1

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Max value: 120

  • Min value: 0

  • Default value: 15

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records.

records

array[ntp_server]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "authentication_enabled": 1,
      "key": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "id": 10
      },
      "server": "time.nist.gov",
      "version": "auto"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_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

next

href

self

href

_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.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.