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

Retrieve NTP symmetric authentication keys

Contributors
PDFs

GET /cluster/ntp/keys

Introduced In: 9.7

Retrieves the collection of NTP symmetric authentication keys known by ONTAP that are uniquely indexed by an identifier.

  • cluster time-service ntp key show

Learn more

Parameters

Name Type In Required Description

id

integer

query

False

Filter by id

  • Max value: 65535

  • Min value: 1

value

string

query

False

Filter by value

digest_type

string

query

False

Filter by digest_type

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: 1

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_key]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "digest_type": "sha1",
      "id": 10,
      "value": "da39a3ee5e6b4b0d3255bfef95601890afd80709"
    }
  ]
}

Error

Status: Default, Error
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

next

href

self

href

_links

Name Type Description

self

href

ntp_key

Name Type Description

_links

_links

digest_type

string

The type of cryptographic hash used to create and verify the NTP's message authentication code appended to each NTP packet header.

id

integer

NTP symmetric authentication key identifier or index number (ID). This ID is included in the NTP cryptographic hash encoded header.

value

string

A hexadecimal digit string that represents the cryptographic key that is shared with the remote NTP server. The current expected length is 40 characters.

Use the cryptographic key and key ID to create a unique hash value used to authenticate the rest of the NTP data.

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.