ntp

Resource URIs


URI	Description
<base_URI>/config/running/ntp	NTP commands.


GET URIs	Description
<base_URI>/config/running/ntp	Displays NTP configuration.
<base_URI>/config/running/ntp/authentication-key	Displays Authentication key.
<base_URI>/config/running/ntp/server	Displays NTP server information.


POST URIs	Payload	Description
<base_URI>/config/running/ntp	<server><ip>(ip-address)</ip><use-vrf>(vrf-name)</use-vrf></server>	Configures NTP server.
<base_URI>/config/running/ntp	<authentication-key><keyid>(unit32)</keyid><md5>{string}</md5></authentication-key>	Configures authentication key and MD5 message-digest algorithm.
<base_URI>/config/running/ntp	<server><ip>(ip-address)</ip><use-vrf>(vrf-name)</use-vrf><key>(unit32)</key></server>	Configures NTP server key.
<base_URI>/config//running/ntp/disable	<all> \| <server>	Disables the NTP server/client mode. Disabling the NTP server/client mode does not remove the configuration.
<base_URI>/config/running/ntp/authentication-key	<key-id-1 > <key-id-2> <key-id-n>	This command enables or disables the NTP authentication at global level. If the authentication is enabled, the NTP packets from servers, peers, clients not having MAC is dropped. Only those servers/peers configured with key authentication is considered for time synchronization. Client requests only with authentication is served, whose key-IDs match with one of the trusted key-IDs.
<base_URI>/config/running/ntp/master	< key key-id > < use-vrf vrf-name >	Configures the device as an authoritative NTP Server. ntp master enables device to use its own clock to synchronize with peers/clients. This command is not effective, if the NTP is enabled in client-only mode. .
<base_URI>/config/running/ntp/server	<ipv4 \| ipv6 > <vrf name >	Specifies or adds an NTP server IP address and optionally associates an authentication key to the server.
<base_URI>/config/running/ntp/trusted-key	<key-id-1 > <key-id-2> <key-id-n>	Configures additional subset of trusted key-IDs which can be used for NTP and client authentication. The keys configured for server/peer is implicitly considered as part of trusted keys.
<base_URI>/config/running/ntp/peer/	<ipv4 \| ipv6 > <vrf name >	Configures the NTP peers and specify the peers to synchronize the system clock. Maximum 8 NTP peers can be configured


DELETE URIs
<base_URI>/config/running/ntp
<base_URI>/config/running/ntp/server/{ip}/use-vrf
<base_URI>/config/running/ntp/server/{ip}/user-vrf/{vrf-name},{keyid}

Parameters

authentication-key: Configures authentication key parameters.
server: Configures NTP server parameters.
ip: Configures the source ip to be used for NTP.
keyid: Specifies authentication key ID. Valid range is from 0 to 65535.
use-vrf: Specifies the VRF to be used.
key: Specifies the key.
md5: Specifies a string for the MD5 message-digest algorithm. The string can be a maximum of 15 ASCII characters.

Usage Guidelines

GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.

Examples

URI

The following example uses the GET option to retrieve the configuration details.

http://host:80/rest/config/running/ntp

None

<ntp xmlns="urn:brocade.com:mgmt:brocade-ntp" xmlns:y="http://brocade.com/ns/rest" y:self="/rest/config/running/ntp">
  <server y:self="/rest/config/running/ntp/server/10.1.1.2%2Cmgmt-vrf">
    <ip>10.1.1.2</ip>
    <use-vrf>mgmt-vrf</use-vrf>
  </server>
</ntp>

URI

The following example uses the POST option to configure authentication-key.

http://host:80/rest/config/running/ntp

<authentication-key>
  <keyid>50</keyid>
  <md5>{teesting}</md5>
</authentication-key>

URI

The following example uses the DELETE option to remove NTP configuration.

http://host:80/rest/config/running/ntp

None