upsertDHCPRelayService

The upsertDHCPRelayService operation handles configuration related to DHCPRelayService 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	False	string	A string that represents the name of the object
ipv4RelayTimeout	False	integer	Set the number of seconds allowed for relay address handling. Field level constraints: must be between 1 and 3600 (inclusive). (Note: Additional constraints might exist)
ipv6RelayTimeout	False	integer	Specifies the amount of time in seconds that is allowed for responses from the DHCPv6 server to pass to the DHCPv6 client through the relay binding for relay address handling. Field level constraints: must be between 1 and 3600 (inclusive). (Note: Additional constraints might exist)
servers	False	[object]	DHCP Servers
agents	False	[object]	DHCP Relay agents
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.

Query Parameters

Parameter	Required	Type	Description
filter	False	string	The criteria used to filter the models you are requesting. It should have the following format: {key}{operator}{value}[;{key}{operator}{value}]. Supported operators are: "!"(not equals), ":"(equals), "~"(similar). Supported keys are: "name", "fts". The "fts" filter cannot be used with other filters. Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertDHCPRelayService' operation
  ftd_configuration:
    operation: "upsertDHCPRelayService"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        ipv4RelayTimeout: "{{ ipv4_relay_timeout }}"
        ipv6RelayTimeout: "{{ ipv6_relay_timeout }}"
        servers: "{{ servers }}"
        agents: "{{ agents }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"