upsertDHCPServerContainer

The upsertDHCPServerContainer operation handles configuration related to DHCPServerContainer 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
autoConfig	True	boolean	A Boolean value, TRUE or FALSE (the default). The TRUE value indicates that the DHCP configuration will be obtained from a specified interface. Field level constraints: cannot be null. (Note: Additional constraints might exist)
primaryDNS	False	string	The IP address of the primary Domain Name System (DNS) server clients should use for domain name resolution. Click Use OpenDNS if you want to configure the OpenDNS public DNS servers. Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
secondaryDNS	False	string	The IP address of the secondary Domain Name System (DNS) server clients should use for domain name resolution. Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
primaryWINS	False	string	The IP address of the primary Windows Internet Name Service (WINS) server clients should use for NetBIOS name resolution. Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
secondaryWINS	False	string	The IP address of the secondary Windows Internet Name Service (WINS) server clients should use for NetBIOS name resolution. Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
servers	False	[object]	A list of the names of DHCPServer objects, which define the DHCP servers configured on the device interfaces.
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)
interface	False	object	The interface to provide DHCP addresses when auto configuration is selected. Allowed types are: [BridgeGroupInterface, EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
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 'upsertDHCPServerContainer' operation
  ftd_configuration:
    operation: "upsertDHCPServerContainer"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        autoConfig: "{{ auto_config }}"
        primaryDNS: "{{ primary_dns }}"
        secondaryDNS: "{{ secondary_dns }}"
        primaryWINS: "{{ primary_wins }}"
        secondaryWINS: "{{ secondary_wins }}"
        servers: "{{ servers }}"
        id: "{{ id }}"
        interface: "{{ interface }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"