editDomainNameFeed

The editDomainNameFeed operation handles configuration related to DomainNameFeed 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 mandatory string representing the Feed Name. The string cannot have spaces or HTML tags.
updateFrequency	False	string	How often the system should update the feed.
lastUpdate	False	string	The date and time of the most recent successful feed update. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
feedURL	True	string	A mandatory URL string specifying the external URL of the feed. Field level constraints: cannot be null, must be a valid URL. (Note: Additional constraints might exist)
checksumURL	False	string	An optional URL string that points to a checksum file. The system can use the checksum to determine if the feed has been updated since the last download. A checksum URL is required if you specify FIVE_MINS as the update frequency. Field level constraints: must be a valid URL. (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 'editDomainNameFeed' operation
  ftd_configuration:
    operation: "editDomainNameFeed"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        updateFrequency: "{{ update_frequency }}"
        lastUpdate: "{{ last_update }}"
        feedURL: "{{ feed_url }}"
        checksumURL: "{{ checksum_url }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"