upsertNetworkObject

The upsertNetworkObject operation handles configuration related to NetworkObject model.

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 is the name of the network object. Field level constraints: cannot be null, length must be between 0 and 128 (inclusive), cannot have HTML, must match pattern ^[a-zA-Z0-9][a-zA-Z0-9.+-]*. (Note: Additional constraints might exist)
description	False	string	A string containing the description information Field level constraints: length must be between 0 and 200 (inclusive), cannot have HTML. (Note: Additional constraints might exist)
subType	False	string	An enum value that specifies the network object type HOST - A host type. NETWORK - A network type. (Note that IPRANGE and FQDN are not supported) Field level constraints: cannot be null. (Note: Additional constraints might exist)
value	False	string	A string that defines the address content for the object. For HOST objects, this is a single IPv4 or IPv6 address without netmask or prefix. For NETWORK objects, this is an IPv4 or IPv6 network address with netmask (in CIDR notation) or prefix. Field level constraints: cannot be null, must match pattern ^((?!;).)*$, cannot have HTML. (Note: Additional constraints might exist)
isSystemDefined	False	boolean	A Boolean value, TRUE or FALSE(the default). The TRUE value indicates that this Network object is a system defined object
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 ^((?!;).)*$, cannot have HTML. (Note: Additional constraints might exist)
type	False	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	Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertNetworkObject' operation
  ftd_configuration:
    operation: "upsertNetworkObject"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        subType: "{{ sub_type }}"
        value: "{{ value }}"
        isSystemDefined: "{{ is_system_defined }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"