POST /api/lunasa/ntp/actions/{actionid}

POST /api/lunasa/ntp/actions/{actionid}

Performs the specified action.

User Privileges

Users with the following role privileges can perform this command:

• admin
• operator

Parameters

actionid

This parameter specifies the id of the action to be performed.

Use: Required

JSON Schema:

    Object
    type:string

server

This parameter specifies the address of server that is used for NTP synchronization.This parameter will be validated.

Use: Optional

JSON Schema:

    Object
    type:string
    minLength: 1
    maxLength: 128
    pattern: ^([a-zA-Z0-9\\-\\.\\[\\]_:]*)$

nts

This parameter is used to enable Authentication.

Use: Optional

JSON Schema:

    Object
    type:bool

keyId

Specifies the key id used in communication with the NTP server.

Use: Optional

JSON Schema:

    Object
    type: integer
    minValue: 1
    maxValue: 65535

protocolVersion

Specifies the protocol version used in communication with the NTP server. Note: NTS Authentication is supported with protocol version 4 only.

Use: Optional

JSON Schema:

    Object
    type: integer
    minValue: 3
    maxValue: 4

Responses

204

success.

400

FRAMEWORK_BAD_REQUEST

We failed to parse your request.

400

NTP_INVALID_AUTHENTICATION

Parameters used for ntp authentication are invalid.

409

SYSCONF_CONFIG_NTP_SERVICE_RUNNING

NTP service must be stopped before requesting this resource.

500

NTP_OPERATION_FAILED

Unable to perform requested operation.

Example Request

    POST
    https://1.2.3.4:8443/api/lunasa/ntp/actions/synchronize
    {
        "server": "1.2.3.12"
    }

Example Response

Notes

Synchronization requires the NTP service to be stopped.