API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create a new NTP profile

NTP profile defining time server associations, authentication
parameters, and synchronization settings. Each entity is
identified by profile name. Use these APIs to create,
modify, or delete an NTP profile instance.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Profile name, upon creation and scope mapping,
NTP functionality will be automatically enabled
on the device.

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

boolean
Defaults to false

Enable authentication on outgoing packets generated by
client to the server.

authentication-profile
array of objects
length ≤ 2147483647

Authentication profile entries.

authentication-profile
trusted-key
array of int64s
length ≤ 2147483647
trusted-key
conductor
array of objects
length ≤ 2147483647

NTP conductor configuration entries.

conductor
boolean
Defaults to false

Enable debug mode to display verbose level logs.

boolean
Defaults to false

Enable client configurations over Dynamic Host Configuration Protocol (DHCP).

string
enum

Source interface identifier, this cannot co-exist with time
serve functionality. Ensure atleast one server entry is configured,
prior to enabling this leaf.

Show Details
LOOPBACKLoopback interface.
VLANVirtual Local Area Network.
Allowed:
int32
1 to 4094

Source Virtual Local Area Network (VLAN) identifier,
only valid when source interface type is set to VLAN.

time-serve
array of int32s
length ≤ 2147483647
time-serve
traps
array of strings
length ≤ 2147483647
Show Details
NTP_ALIVE_HEARTBEATEntity is still alive.
NTP_ALLAll types of traps.
NTP_CONFIG_CHANGEConfiguration changed.
NTP_LEAPSEC_ANNOUNCEDNew leap second announced.
NTP_MODE_CHANGEState change of a mode.
NTP_NEW_ASSOCIATIONNew association is mobilized.
NTP_PEER_CHANGEChange in peer.
NTP_REMOVE_ASSOCIATIONExisting association is demobilized.
NTP_STRATUM_CHANGEChange in stratum level.
traps
int32
1 to 8
Defaults to 8

Maximum number of client associations.

string
enum
Defaults to BROADCAST

NTP operation mode, either unicast or broadcast (default).

Show Details
BROADCASTOperate in broadcast mode.
UNICASTOperate in unicast mode.
Allowed:
boolean
Defaults to false

NTP server mode, sets default access control for client to
interact with server.

servers
array of objects
length ≤ 2147483647

NTP server entries.

servers
string
length between 1 and 256

Alias profile for NTP server configurations.

string
length between 1 and 256

Profile description.

string
length between 1 and 256

Profile name, upon creation and scope mapping,
NTP functionality will be automatically enabled
on the device.

string
length ≤ 9999

Client VRF used to request time, ensure the VRF is pre-configured.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json