editNetworkObject

The editNetworkObject operation handles configuration related to NetworkObject 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 that is the name of the network object.
description	False	string	A string containing the description information Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
subType	True	string	An enum value that specifies the network object type HOST - A host type. NETWORK - A network type. FQDN - A FQDN type. RANGE - A range type. Field level constraints: cannot be null. (Note: Additional constraints might exist)
value	True	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. For FQDN objects, this is a Fully qualified domain name. For RANGE objects, this is IPv4 or IPv6 addresses separated by '-' Field level constraints: cannot be null, must match pattern ^((?!;).)*$. (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
dnsResolution	False	string	DNS Resolution type can be IPV4_ONLY, IPV6_ONLY or IPV4_AND_IPV6
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 'editNetworkObject' operation
  ftd_configuration:
    operation: "editNetworkObject"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        subType: "{{ sub_type }}"
        value: "{{ value }}"
        isSystemDefined: "{{ is_system_defined }}"
        dnsResolution: "{{ dns_resolution }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"