Description

The addBridgeGroupInterface operation handles configuration related to BridgeGroupInterface model. 
This API call is not allowed on the standby unit in an HA pair.

HTTP request

POST /api/fdm/v6/devices/default/bridgegroupinterfaces

Data Parameters

Parameter Required Type Description
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)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "bridgeGroupId": 0,
        "description": "string",
        "hardwareName": "string",
        "id": "string",
        "ipv4": {
            "addressNull": true,
            "defaultRouteUsingDHCP": true,
            "dhcp": true,
            "dhcpRouteMetric": 0,
            "ipAddress": {
                "ipAddress": "string",
                "netmask": "string",
                "standbyIpAddress": "string",
                "type": "haipv4address"
            },
            "ipType": "DHCP",
            "type": "interfaceipv4"
        },
        "ipv6": {
            "autoConfig": true,
            "dadAttempts": 0,
            "dhcpForManagedConfig": true,
            "dhcpForOtherConfig": true,
            "enableRA": true,
            "enabled": true,
            "ipAddresses": [],
            "linkLocalAddress": {
                "ipAddress": "string",
                "standbyIpAddress": "string",
                "type": "haipv6address"
            },
            "prefixes": [],
            "type": "interfaceipv6"
        },
        "monitorInterface": true,
        "name": "string",
        "selectedInterfaces": [],
        "type": "bridgegroupinterface",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/devices/default/bridgegroupinterfaces"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def add_bridge_group_interface(client, body):
    return client.Interface.addBridgeGroupInterface(
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    body = {'bridgeGroupId': 0,
 'description': 'string',
 'hardwareName': 'string',
 'ipv4': {'addressNull': True,
          'defaultRouteUsingDHCP': True,
          'dhcp': True,
          'dhcpRouteMetric': 0,
          'ipAddress': {'ipAddress': 'string',
                        'netmask': 'string',
                        'standbyIpAddress': 'string',
                        'type': 'haipv4address'},
          'ipType': 'DHCP',
          'type': 'interfaceipv4'},
 'ipv6': {'autoConfig': True,
          'dadAttempts': 0,
          'dhcpForManagedConfig': True,
          'dhcpForOtherConfig': True,
          'enableRA': True,
          'enabled': True,
          'ipAddresses': [],
          'linkLocalAddress': {'ipAddress': 'string',
                               'standbyIpAddress': 'string',
                               'type': 'haipv6address'},
          'prefixes': [],
          'type': 'interfaceipv6'},
 'monitorInterface': True,
 'name': 'string',
 'selectedInterfaces': [],
 'type': 'bridgegroupinterface'}

    add_bridge_group_interface(client, body)