editNTP

The editNTP operation handles configuration related to NTP model.

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter	Required	Type	Description
version	False	string	A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
enabled	False	boolean	A Boolean value, TRUE or FALSE. The TRUE value indicates that NTP service is enabled. FALSE indicates that NTP isn't active.
description	False	string	An optional Unicode string, from 0 to 200 characters. The string cannot include HTML tags.
ntpServers	True	[string]	A list of Strings that hold the IP address or Fully Qualified Domain Name(FQDN) of NTP Servers. NTP service refers to the list of NTP servers to keep the clock synchronized. Field level constraints: cannot be null. (Note: Additional constraints might exist)
id	False	string	A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Path Parameters

Parameter	Required	Type	Description
objId	True	string

Example

- name: Execute 'editNTP' operation
  ftd_configuration:
    operation: "editNTP"
    data:
        version: "{{ version }}"
        enabled: "{{ enabled }}"
        description: "{{ description }}"
        ntpServers: "{{ ntp_servers }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"