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

Create an NTP symmetric authentication key entry

Contributors
PDFs

POST /cluster/ntp/keys

Introduced In: 9.7

Creates an NTP symmetric authentication key entry including the type of key using an unused identifier or index number (ID).

Required properties

  • id - Shared symmetric key number (ID).

  • digest_type - Shared private key cryptographic hash type.

  • value - Value of shared private key.

  • cluster time-service ntp key create

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

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.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "digest_type": "sha1",
  "id": 10,
  "value": "da39a3ee5e6b4b0d3255bfef95601890afd80709"
}

Response

Status: 201, Created

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

2097187

Invalid value for an NTP symmetric authentication key. A SHA1 key must be exactly 40 hexadecimal digits.

2097189

Too many NTP keys have been configured.
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

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.