Endpoint

/v2/time/settings

GET

Retrieve this cluster's time-management configuration. Refer to the 'Set Time Configuration' method for a description of the returned fields.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_time_config_v2",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "enum": [
        "API_TIME_SOURCE_NTP",
        "API_TIME_SOURCE_HYPERVISOR"
      ],
      "description": "The time source type: For ANQ, must be the hypervisor-provided time source. For all platforms other than CNQ on Azure, must be an NTP server. For CNQ on Azure, can be either an NTP server or the hypervisor-provided time source.:\n * `API_TIME_SOURCE_HYPERVISOR` - API_TIME_SOURCE_HYPERVISOR,\n * `API_TIME_SOURCE_NTP` - API_TIME_SOURCE_NTP"
    },
    "use_ad_for_primary": {
      "description": "Use AD as the primary time source",
      "type": "boolean"
    },
    "ntp_servers": {
      "type": "array",
      "items": {
        "description": "List of NTP servers",
        "type": "string"
      }
    }
  }
}

PUT

Set this cluster's time-management configuration.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "api_time_config_v2",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "enum": [
        "API_TIME_SOURCE_NTP",
        "API_TIME_SOURCE_HYPERVISOR"
      ],
      "description": "The time source type: For ANQ, must be the hypervisor-provided time source. For all platforms other than CNQ on Azure, must be an NTP server. For CNQ on Azure, can be either an NTP server or the hypervisor-provided time source.:\n * `API_TIME_SOURCE_HYPERVISOR` - API_TIME_SOURCE_HYPERVISOR,\n * `API_TIME_SOURCE_NTP` - API_TIME_SOURCE_NTP"
    },
    "use_ad_for_primary": {
      "description": "Use AD as the primary time source",
      "type": "boolean"
    },
    "ntp_servers": {
      "type": "array",
      "items": {
        "description": "List of NTP servers",
        "type": "string"
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_time_config_v2",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "enum": [
        "API_TIME_SOURCE_NTP",
        "API_TIME_SOURCE_HYPERVISOR"
      ],
      "description": "The time source type: For ANQ, must be the hypervisor-provided time source. For all platforms other than CNQ on Azure, must be an NTP server. For CNQ on Azure, can be either an NTP server or the hypervisor-provided time source.:\n * `API_TIME_SOURCE_HYPERVISOR` - API_TIME_SOURCE_HYPERVISOR,\n * `API_TIME_SOURCE_NTP` - API_TIME_SOURCE_NTP"
    },
    "use_ad_for_primary": {
      "description": "Use AD as the primary time source",
      "type": "boolean"
    },
    "ntp_servers": {
      "type": "array",
      "items": {
        "description": "List of NTP servers",
        "type": "string"
      }
    }
  }
}

PATCH

Set just the provided components of this cluster's time-management configuration.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "api_time_config_v2_patch",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "enum": [
        "API_TIME_SOURCE_NTP",
        "API_TIME_SOURCE_HYPERVISOR"
      ],
      "description": "The time source type: For ANQ, must be the hypervisor-provided time source. For all platforms other than CNQ on Azure, must be an NTP server. For CNQ on Azure, can be either an NTP server or the hypervisor-provided time source.:\n * `API_TIME_SOURCE_HYPERVISOR` - API_TIME_SOURCE_HYPERVISOR,\n * `API_TIME_SOURCE_NTP` - API_TIME_SOURCE_NTP"
    },
    "use_ad_for_primary": {
      "description": "Use AD as the primary time source",
      "type": "boolean"
    },
    "ntp_servers": {
      "type": "array",
      "items": {
        "description": "List of NTP servers",
        "type": "string"
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_time_config_v2",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "enum": [
        "API_TIME_SOURCE_NTP",
        "API_TIME_SOURCE_HYPERVISOR"
      ],
      "description": "The time source type: For ANQ, must be the hypervisor-provided time source. For all platforms other than CNQ on Azure, must be an NTP server. For CNQ on Azure, can be either an NTP server or the hypervisor-provided time source.:\n * `API_TIME_SOURCE_HYPERVISOR` - API_TIME_SOURCE_HYPERVISOR,\n * `API_TIME_SOURCE_NTP` - API_TIME_SOURCE_NTP"
    },
    "use_ad_for_primary": {
      "description": "Use AD as the primary time source",
      "type": "boolean"
    },
    "ntp_servers": {
      "type": "array",
      "items": {
        "description": "List of NTP servers",
        "type": "string"
      }
    }
  }
}