ntpserver

Last published : Oct 30, 2026
Configuration for NTP server resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
serverip <String> Read-write IP address of the NTP server.
Minimum length = 1
servername <String> Read-write Fully qualified domain name of the NTP server.
minpoll <Integer> Read-write Minimum time after which the NTP server must poll the NTP messages. In seconds, expressed as a power of 2.
Minimum value = 4
Maximum value = 17
maxpoll <Integer> Read-write Maximum time after which the NTP server must poll the NTP messages. In seconds, expressed as a power of 2.
Minimum value = 4
Maximum value = 17
autokey <Boolean> Read-write Use the Autokey protocol for key management for this server, with the cryptographic values (for example, symmetric key, host and public certificate files, and sign key) generated by the ntp-keygen utility. To require authentication for communication with the server, you must set either the value of this parameter or the key parameter.
key <Integer> Read-write Key to use for encrypting authentication fields. All packets sent to and received from the server must include authentication fields encrypted by using this key. To require authentication for communication with the server, you must set either the value of this parameter or the autokey parameter.
Minimum value = 1
Maximum value = 65534
preferredntpserver <String> Read-write Preferred NTP server. The Citrix ADC chooses this NTP server for time synchronization among a set of correctly operating hosts.
Default value: NO
Possible values = YES, NO
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • ADD
  • DELETE
  • UPDATE
  • UNSET
  • GET (ALL)
  • COUNT
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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/ntpserver HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"ntpserver":{
"serverip":<String_value>,
"servername":<String_value>,
"minpoll":<Integer_value>,
"maxpoll":<Integer_value>,
"autokey":<Boolean_value>,
"key":<Integer_value>
}}
Response: HTTP Status Code on Success: 201 Created
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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/ntpserver/ serverip_value<String> Query-parameters: args=servername: <String_value>

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/ntpserver HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"ntpserver":{
"serverip":<String_value>,
"servername":<String_value>,
"minpoll":<Integer_value>,
"maxpoll":<Integer_value>,
"preferredntpserver":<String_value>,
"autokey":<Boolean_value>,
"key":<Integer_value>
}}
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/ntpserver? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"ntpserver":{
"serverip":<String_value>,
"servername":<String_value>,
"autokey":true,
"minpoll":true,
"maxpoll":true,
"preferredntpserver":true,
"key":true
}}
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/ntpserver Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/ntpserver? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter http:// <netscaler-ip-address> /nitro/v1/config/ntpserver? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of ntpserver resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/ntpserver? view=summary
Use this query-parameter to get the summary output of ntpserver resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination http:// <netscaler-ip-address> /nitro/v1/config/ntpserver? pagesize=#no;pageno=#no
Use this query-parameter to get the ntpserver resources in chunks.
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:
{ "ntpserver": [ {
"serverip":<String_value>,
"servername":<String_value>,
"minpoll":<Integer_value>,
"maxpoll":<Integer_value>,
"preferredntpserver":<String_value>,
"autokey":<Boolean_value>,
"key":<Integer_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/ntpserver? count=yes 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:
{ "ntpserver": [ { "__count": "#no"} ] }