Time



[tags: DMA, RPAD, RPRM, SMCU]

Resource Root

https://localhost:8443/api/rest/config/time-config

Summary


Resources Methods
https://localhost:8443/api/rest/config/time-config

GET Retrieves the current time along with the current time settings.

PUT Configures the server's time settings.

https://localhost:8443/api/rest/config/time-config/timezones

GET  Retrieves the current list of the supported timezones.

Resources


https://localhost:8443/api/rest/config/time-config


Methods

GET

Retrieves the current time along with the current time settings. [tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-time-config+xml
application/vnd.plcm.plcm-time-config+json
Retrieval of time configuration was successful
304
Time configuration has not changed.

Note: The API client must provide the "plcm-time-config" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous
request in the "If-None-Match" header, then the HTTP response will contain the
same information in the message body as the previous request.

The "plcm-time-config" ETag can be accessed from the initial request result's HTTP
response header.

If another client has changed the time configuration, the ETag value will be out of date
and a request with the outdated ETag will return the full "plcm-time-config".
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid credentials.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Retrieving time config requires administrator role.

PUT

Configures the server's time settings. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-time-config+xml
application/vnd.plcm.plcm-time-config+json

Response

Status Representation Description
204 Time settings were applied successfully
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid credentials.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Retrieving time config requires administrator role.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Too many NTP servers were specified in the NTP server list.

The maximum number of NTP servers depends on the underlying product, but 2 should work.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The configuration specified to use NTP but the NTP server list was empty.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
One or more of the servers listed in the NTP server list was not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The timezone specified was not recognized as a valid timezone.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The current time is required when specifying to not use NTP
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The request is being rejected because the RPAD has already been provisioned with time settings.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
NTP servers must be enabled in a supercluster. Manual time cannot be enabled or modified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
NTP servers must be enabled when integrated with RPRM. Manual time cannot be enabled or modified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
NTP servers must be enabled in a HA pair. Manual time cannot be enabled or modified.
500 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
An internal error occurred while attempting to apply the given time setttings.

https://localhost:8443/api/rest/config/time-config/timezones


Methods

GET


Retrieves the current list of the supported timezones. The list of timezones
is dependent on the server's implementation. [tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-timezone-list+xml
application/vnd.plcm.plcm-timezone-list+json
List of the current timezones supported on the server
304
The list of timezones and offsets has not changed.

Note: The API client must provide the "plcm-timezone-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous
request in the "If-None-Match" header, then the HTTP response will contain the
same information in the message body as the previous request.

The "plcm-timezone-list" ETag can be accessed from the initial request result's HTTP
response header.

If another client has changed the time configuration, the ETag value will be out of date
and a request with the outdated ETag will return the full "plcm-timezone-list".
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid credentials.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Retrieving time config requires administrator role.