editDDNSService

The editDDNSService operation handles configuration related to DDNSService 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.
name	True	string	A string containing the name of the object, up to 235 characters in length
webUpdateType	True	string	An enum value that specifies the types of addresses to be updated, based on what is supported by your DDNS service provider. Supported values are ['ALL_ADDRESSES', 'IPV4_ADDRESS', 'IPV4_ONE_IPV6_ADDRESS', 'ONE_IPV6_ADDRESS', 'ALL_IPV6_ADDRESSES'] Field level constraints: cannot be null. (Note: Additional constraints might exist)
serviceProvider	True	string	An enum value that specifies the type of service provider. Supported values are ['NO_IP', 'DYNDNS', 'GOOGLE', 'FMC_LTP', 'CUSTOM_URL'] Field level constraints: cannot be null. (Note: Additional constraints might exist)
customWebURL	False	string	The URL of the Custom Service Provider Field level constraints: length must be between 0 and 511 (inclusive). (Note: Additional constraints might exist)
userName	False	string	The username of the DDNS Service Provider
password	False	string	The password of the DDNS Service Provider
ddnsInterfaceSettings	True	[object]	An object containing list of ddns interface settings. Field level constraints: cannot be null. (Note: Additional constraints might exist)
updateInterval	True	string	An enum value that specifies the type of update interval. Supported values are ['ON_CHANGE', 'HOURLY', 'DAILY', 'MONTHLY'] Field level constraints: cannot be null. (Note: Additional constraints might exist)
runTimes	False	string	A mandatory UTF8 string containing a cron specification (following the Java(tm)/Spring(tm) conventions). The string must contain six space-separated fields representing the seconds, minutes, hours, dayOfTheMonth, month, dayOfTheWeek, year (time is in UTC). Depending on the scheduleType some values are not allowed. For the HOURLY schedule type the following constraints apply: seconds = 0; minutes: 0, hours: , dayOfTheMonth: ?, month: , dayOfTheWeek: , year: . For the DAILY schedule type the following constraints apply: seconds = 0; minutes: 0-59, hours: 0-23, dayOfTheMonth: , month: , dayOfTheWeek: , year: . For the MONTHLY schedule type the following constraints apply: seconds = 0; minutes: 0-59, hours: 0-23, dayOfTheMonth: 1-31, month: , dayOfTheWeek: ?, year: . Examples: '0 0 12 * * ? ' - schedule at 12:00 PM (noon) every day. '0 15 10 15 * ? ' - schedule at 10:15 AM on the 15th day of every month. '0 59 23 31 1 ? 2020' schedule at 11:59 PM on Jan/31 2020. Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).) $. (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 'editDDNSService' operation
  ftd_configuration:
    operation: "editDDNSService"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        webUpdateType: "{{ web_update_type }}"
        serviceProvider: "{{ service_provider }}"
        customWebURL: "{{ custom_web_url }}"
        userName: "{{ user_name }}"
        password: "{{ password }}"
        ddnsInterfaceSettings: "{{ ddns_interface_settings }}"
        updateInterval: "{{ update_interval }}"
        runTimes: "{{ run_times }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"