Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

ntpparam

August 17, 2023
Contributed by: 
C

Configuration for NTP parameter resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
authentication Read-write Apply NTP authentication, which enables the NTP client (Citrix ADC) to verify that the server is in fact known and trusted.

Default value: YES

Possible values = YES, NO
trustedkey <Double[]> Read-write Key identifiers that are trusted for server authentication with symmetric key cryptography in the keys file.

Minimum value = 1

Maximum value = 65534
autokeylogsec Read-write Autokey protocol requires the keys to be refreshed periodically. This parameter specifies the interval between regenerations of new session keys. In seconds, expressed as a power of 2.

Default value: 12

Minimum value = 0

Maximum value = 32
revokelogsec Read-write Interval between re-randomizations of the autokey seeds to prevent brute-force attacks on the autokey algorithms.

Default value: 16

Minimum value = 0

Maximum value = 32

Operations

(click to see Properties )

  • UPDATE
  • UNSET
  • GET (ALL)

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: *

Mandatory parameters are marked in red and placeholder content is marked in green

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/ntpparam

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"ntpparam":{
      "authentication":<String_value>,
      "trustedkey":<Double[]_value>,
      "autokeylogsec":<Double_value>,
      "revokelogsec":<Double_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/ntpparam? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"ntpparam":{
      "authentication":true,
      "trustedkey":true,
      "autokeylogsec":true,
      "revokelogsec":true
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/ntpparam

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{ "ntpparam": [ {
      "authentication":<String_value>,
      "trustedkey":<Double[]_value>,
      "autokeylogsec":<Double_value>,
      "revokelogsec":<Double_value>
}]}

<!--NeedCopy-->
ntpparam
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.