Cisco IOS XE REST API Management Reference Guide

IOS XE 3.10

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

kind

string

Mandatory

Object type. Always “collection#ntp-server”

ntp-servers

array

Mandatory

Array of ntp server objects

ntp-servers [ ].kind

string

Mandatory

Array object type. Always “object#ntp-server”

ntp-servers [ ].ip-address

string

Mandatory

CIDR format: x.x.x.x/nn or name

POST

/api/v1/global/ntp/servers

GET

/api/v1/global/ntp/servers

Hostname

string

NTP server hostname. Either an IP address or a hostname must be configured. Read-only once the resource is created.

GET

/api/v1/global/ntp/servers/{ntp-server-id}

DELETE

/api/v1/global/ntp/servers/{ntp-server-id}

IOS XE 3.10

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

kind

string

“object#ntp-status”

synchronized

boolean

“false” if system is not synchronized to any NTP peer, “true” otherwise.

stratum

number

NTP stratum of this system.

reference

string

IP address of peer that the system is synchronized to. For IPv4 address, the address format is x.x.x.x

Other possible values:

INIT (initial state) when unsynchronized

LOOP – Sync to local clock

STEP – clock stepped

DOWN – unspecified stratum case

nominal-freq

number

Nominal frequency of system hardware clock (in Hertz).

actual-freq

number

Measured frequency of system hardware clock (in Hertz).

precision

string

Precision of the clock of this system (in Hertz).

reference-time

number

Reference time stamp in hex UTC.

clock-offset

number

Offset of the system clock to synchronized peer. It is in ms.

root-delay

number

Total delay along path to root clock. It is in ms.

root-dispersion

number

Dispersion of root path. It is in ms.

peer-dispersion

number

Dispersion of synchronized peer. It is in ms.

ntp-uptime

number

The uptime of the NTP entity, (i.e., the time since ntp was (re-)initialized not sysUptime!). The unit is timeticks (1/100 of seconds). “xx:xx:xx UTC”

resolution

number

The time resolution in integer format, where the resolution is represented as divisions of a second—for example, a value of 1000 translates to 1.0 ms

last-update

number

Indicates when the clock was last updated in milliseconds. The value is 0 if it’s never been updated.

loop-filter-state

string

The clock state: NSET(never set), FSET(drift set from file), SPIK(Spike), FREQ(Drift being measured),CTRL(normal controlled loop), UNSP(unspecified), UNKN (unknown)

drift

number

The frequency offset between the local clock hardware and the authoritative time from the NTP servers. The value is X seconds per second.

System-poll-interval

number

The value is in seconds.

GET

/api/v1/global/ntp/status

IOS XE 3.10

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

kind

string

Must be collection#ntp-server-active

peer-info

string

Can be one or more of the following:

• “Synchronized to this peer”
• “Almost synchronized to this peer”
• “Peer selected for possible synchronization”
• “Peer is a candidate for selection”
• “Peer is statically configured”

Items

array

List of NTP servers’ run-time information

Items-kind

string

Must be object#ntp-server-active

address

ipaddress

Address of peer.

Ref-clock

ipaddress

Address of reference clock of peer.

Stratum

number

Stratum of peer.

when

number

Time since last NTP packet was received from peer.

poll

number

Polling interval (in seconds).

reach

number

Peer reachability (bit string, in octal).

delay

number

Round-trip delay to peer (in milliseconds).

offset

number

Relative time of peer clock to local clock (in milliseconds).

dispersion

number

Dispersion

GET

/api/v1/global/ntp/servers/active