ntp¶
Network Time Protocol configuration
ntp Specification¶
Parameter Value Type Intermediate Resource Element Name ntp Element URI /axapi/v3/ntp Element Attributes ntp_attributes Partition Visibility shared Schema ntp schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/ntp | ntp_attributes |
ntp attributes¶
auth-key-list
Type: List
Reference Object: /axapi/v3/ntp/auth-key/{key}
ntp-global
Description: ntp-global is a JSON Block. Please see below for ntp-global
Type: Object
Reference Object: /axapi/v3/ntp/ntp-global
server
Description: server is a JSON Block. Please see below for server
Type: Object
Reference Object: /axapi/v3/ntp/server
trusted-key-list
Type: List
Reference Object: /axapi/v3/ntp/trusted-key/{key}
auth-key-list¶
Specification Value Type list Block object keys alg-type
Description ‘M’: encryption using MD5; ‘SHA’: encryption using SHA; ‘SHA1’: encryption using SHA1;
Type: string
Supported Values: M, SHA, SHA1
asc-key
Description
Type: string
Format: password
Maximum Length: 20 characters
Maximum Length: 1 characters
Mutual Exclusion: asc-key and hex-key are mutually exclusive
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)
Mutual Exclusion: encrypted and hex-encrypted are mutually exclusive
hex-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)
Mutual Exclusion: hex-encrypted and encrypted are mutually exclusive
hex-key
Description
Type: string
Format: password
Maximum Length: 40 characters
Maximum Length: 21 characters
Mutual Exclusion: hex-key and asc-key are mutually exclusive
key
Description authentication key
Type: number
Range: 1-65535
key-type
Description ‘ascii’: key string in ASCII form; ‘hex’: key string in hex form;
Type: string
Supported Values: ascii, hex
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
trusted-key-list¶
Specification Value Type list Block object keys key
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ntp-global¶
Specification Value Type object allow-data-ports
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
server¶
Specification Value Type object hostname-list
Type: List
Reference Object: /axapi/v3/ntp/server/hostname/{host-servername}
server_hostname-list¶
Specification Value Type list Block object keys action
Description ‘enable’: Enable this NTP server; ‘disable’: Disable this NTP server;
Type: string
Supported Values: enable, disable
Default: enable
host-servername
Description IPV4 address, IPV6 address or host name of NTP server(string1~63)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
key
Description Use trusted key to authenticate this NTP server (The trusted key number to use)
Type: number
Range: 1-65535
Reference Object: /axapi/v3/ntp/trusted-key
prefer
Description Set this NTP server as preferred
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters