ntp_server
Configuration for NTP Server Information resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| preferred_server | <Boolean> | Read-write | NTP Server Preferred. |
| maxpoll | <Integer> | Read-write | Maximum Poll Interval.
Maximum value = |
| minpoll | <Integer> | Read-write | Minimum Poll Interval.
Maximum value = |
| autokey | <Boolean> | Read-write | Autokey Public Key Authentication. |
| key_id | <Integer> | Read-write | Key Identifier for Symmetric Key Authentication.
Maximum value = |
| server | <String> | Read-write | NTP Time Server Address. |
| client | <String> | Read-write | Sender of request, whether from Setup Wizard or direct NTP configuration. |
Operations
(click to see Properties )
- ADD
- DELETE
- GET (ALL)
- GET
- UPDATE
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
The following parameters can be used in the nitro request : onerror <String_value>
Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE
add
URL: https://<MGMT-IP>/nitro/v2/config/ntp_server?onerror=<String_value> HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"ntp_server": {
<b>"server":<String_value></b>,
"client":<String_value>,
"minpoll":<Integer_value>,
"maxpoll":<Integer_value>,
"preferred_server":<Boolean_value>,
"autokey":<Boolean_value>,
"key_id":<Integer_value>}}
<!--NeedCopy-->
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ntp_server":[{
"preferred_server":<Boolean_value>,
"maxpoll":<Integer_value>,
"minpoll":<Integer_value>,
"autokey":<Boolean_value>,
"key_id":<Integer_value>,
"server":<String_value>,
"client":<String_value>}]}
<!--NeedCopy-->
delete
URL: https://<MGMT-IP>/nitro/v2/config/ntp_server/server_value<String> HTTPS Method: DELETE
Request Headers: X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }
<!--NeedCopy-->
get (all)
URL: https://<MGMT-IP>/nitro/v2/config/ntp_server Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/ntp_server ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of ntp_server resources configured on the system. You can set a filter on any property of the resource.
pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ntp_server ?pagesize=#no;pageno=#no Use this query-parameter to get the ntp_server resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/ntp_server ?count=yes Use this query-parameter to get the count of ntp_server resources.
HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ntp_server":[{
"preferred_server":<Boolean_value>,
"maxpoll":<Integer_value>,
"minpoll":<Integer_value>,
"autokey":<Boolean_value>,
"key_id":<Integer_value>,
"server":<String_value>,
"client":<String_value>}]}
<!--NeedCopy-->
get
URL: https://<MGMT-IP>/nitro/v2/config/ntp_server/server_value<String> HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ntp_server":[{
"preferred_server":<Boolean_value>,
"maxpoll":<Integer_value>,
"minpoll":<Integer_value>,
"autokey":<Boolean_value>,
"key_id":<Integer_value>,
"server":<String_value>,
"client":<String_value>}]}
<!--NeedCopy-->
update
URL: https://<MGMT-IP>/nitro/v2/config/ntp_server/server_value<String> HTTPS Method: PUT
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"ntp_server":{
"client":<String_value>,
"minpoll":<Integer_value>,
"maxpoll":<Integer_value>,
"preferred_server":<Boolean_value>,
"autokey":<Boolean_value>,
"key_id":<Integer_value>,
"server":<String_value>}}
<!--NeedCopy-->
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ntp_server":[{
"preferred_server":<Boolean_value>,
"maxpoll":<Integer_value>,
"minpoll":<Integer_value>,
"autokey":<Boolean_value>,
"key_id":<Integer_value>,
"server":<String_value>,
"client":<String_value>}]}
<!--NeedCopy-->