editDataInterfaceManagementAccess

The editDataInterfaceManagementAccess operation handles configuration related to DataInterfaceManagementAccess 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
networkObjects	True	[object]	A mandatory set of network objects, representing one or more addresses or networks, whose data traffic is allowed via the given network interface. Field level constraints: cannot be blank or empty. (Note: Additional constraints might exist) Allowed types are: [NetworkObject]
networkInterface	True	object	A mandatory interface object representing the interface configured for data access. Field level constraints: cannot be null. (Note: Additional constraints might exist) Allowed types are: [BridgeGroupInterface, EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
protocols	True	[object]	A mandatory set of protocol objects, representing one or more protocols, (e.g. HTTPS and SSH) that are allowed via the given network interface and addresses/networks. Field level constraints: cannot be null, cannot be blank or empty. (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 'editDataInterfaceManagementAccess' operation
  ftd_configuration:
    operation: "editDataInterfaceManagementAccess"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        networkObjects: "{{ network_objects }}"
        networkInterface: "{{ network_interface }}"
        protocols: "{{ protocols }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"