editBridgeGroupInterface

The editBridgeGroupInterface operation handles configuration related to BridgeGroupInterface 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	An optional ASCII string, from 0 to 48 characters, representing the name of the interface. The string can only include lower case characters (a-z), numbers (0-9), underscore (_), dot (.), and plus/minus (+,-). The name can only start with an alpha numeric character.
description	False	string	An optional UTF-8 sting, from 0 to 200 characters. The string cannot include HTML tags, semi-colons(;), or carriage returns. Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
hardwareName	False	string	A mandatory UTF-8 string for the PhysicalInterfaces and SubInterfaces, which normally specifies the type of Interface along with the Interface number. The string cannot contain HTML tags. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
monitorInterface	True	boolean	A mandatory boolean object which specifies if the Interface needs to be monitored or not. Field level constraints: cannot be null. (Note: Additional constraints might exist)
ipv4	False	object	An optional IPv4 object assigned to an interface in Secure Firewall device manager. This object specifies Interface configuration for an IPv4 address.
ipv6	False	object	An optional IPv6 object assigned to an interface in Secure Firewall device manager. This object specifies Interface configuration for an IPv6 address.
selectedInterfaces	False	[object]	A set of zero/one or more Physical Interfaces, objects that are grouped together to form a bridge group. Allowed types are: [EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
bridgeGroupId	False	integer	For Internal use. Field level constraints: must be between 1 and 250 (inclusive). (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 'editBridgeGroupInterface' operation
  ftd_configuration:
    operation: "editBridgeGroupInterface"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        hardwareName: "{{ hardware_name }}"
        monitorInterface: "{{ monitor_interface }}"
        ipv4: "{{ ipv4 }}"
        ipv6: "{{ ipv6 }}"
        selectedInterfaces: "{{ selected_interfaces }}"
        bridgeGroupId: "{{ bridge_group_id }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"