Configuring NTP Service Information
Function
This interface is used to configure NTP information.
Syntax
Operation type: PATCH
URL: https://device_ip/redfish/v1/EdgeSystem/NTPService
Request header:
X-Auth-Token: auth_value
Request message body:
{
"ClientEnabled":true,
"NTPLocalServers":"",
"NTPRemoteServers":"9.88.47.12",
"NTPRemoteServersbak":"",
"ServerEnabled":false,
"Target":"Client"
}
Parameters
Parameter |
Description |
Value |
|---|---|---|
device_ip |
IP address for logging in to a device. |
An IPv4 or IPv6 address |
auth_value |
Authentication parameter contained in the request. |
You can obtain the value from the session created by using /redfish/v1/SessionService/Sessions. |
ClientEnabled |
Specifies whether the NTP client is enabled. |
Boolean value: true or false |
NTPLocalServers |
Local IP address used for the NTP service. |
Character string IPv4 address. |
NTPRemoteServers |
IP address of the preferred NTP server. |
Character string IPv4 address. |
NTPRemoteServersbak |
IP address of the alternate NTP server. |
Character string IPv4 address. |
ServerEnabled |
Specifies whether the NTP server is enabled. |
Boolean true or false |
Target |
Configuration type of the NTP service. |
Character string Client/Server |
Usage Guidelines
None
Example
Request:
PATCH https://10.10.10.10/redfish/v1/EdgeSystem/NTPService
Request header:
X-Auth-Token: 6599174c38c36838737d9749179e1ee1
Request message body:
{
"ClientEnabled":true,
"NTPLocalServers":"",
"NTPRemoteServers":"9.88.47.12",
"NTPRemoteServersbak":"",
"ServerEnabled":false,
"Target":"Client"
}
Response:
{
"ClientEnabled": true,
"ServerEnabled": false,
"NTPRemoteServers": "9.88.47.12",
"NTPRemoteServersbak": null,
"NTPLocalServers": ""
}
Response code: 200
Output Description
Attribute |
Type |
Description |
|---|---|---|
ClientEnabled |
Boolean |
Specifies whether the NTP client is enabled. |
ServerEnabled |
Boolean |
Specifies whether the NTP server is enabled. |
NTPRemoteServers |
Character string |
IP address of the preferred NTP server. |
NTPRemoteServersbak |
Character string |
IP address of the alternate NTP server. |
NTPLocalServers |
Character string |
Local IP address used for the NTP service. |
