Description

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

HTTP request

POST /api/fdm/v6/devices/default/etherchannelinterfaces

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.
managementOnly False boolean An optional Boolean value, TRUE or FALSE (default value). The TRUE value indicates that the interface is used for management only. FALSE indicates that interface is not used as a management purpose.
managementInterface False boolean An optional Boolean value, TRUE or FALSE (the default). The TRUE value indicates that the interface is a Management Interface. The value FALSE indicates that the interface is not a Management Interface.
mode True string An enum value that specifies the physical interface mode where ROUTED is default. Supported values are ROUTED and PASSIVE. SWITCHPORT is not supported
Field level constraints: cannot be null. (Note: Additional constraints might exist)
linkState False string This field is deprecated and will not be available in future releases. Instead, please use the linkState field in the /devices/default/operational/interfaces API. An enum value that specifies whether the Physical Interface link state is UP or DOWN (the default). Link state of an interface is the operational status/running status of the interface. The values can be one of the following.
UP - Specifies whether the device is operationally UP.
DOWN - Specifies whether the device is operationally DOWN.
mtu True integer A mandatory Integer value, from 64 bytes to 9198 bytes, with a default value being set to 1500. Maximum Transfer Unit (MTU) is the size of the largest network layer protocol unit that can be communicated in a single network transaction.
Field level constraints: cannot be null, must be between 64 and 9198 (inclusive). (Note: Additional constraints might exist)
enabled True boolean A mandatory Boolean value, TRUE or FALSE (the default), specifies the administrative status of the Interface. The TRUE value enables the administrative status on the device. The value FALSE disables the administrative status on the device.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
macAddress False string An optional String value, to specify a virtual MAC address. The MAC address must be in the format H.H.H where each H is a 16-bit hexadecimal number. For example, 000C.F142.4CDE
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
standbyMacAddress False string An optional String value, to specify a virtual Standby MAC address. The MAC address must be in the format H.H.H where each H is a 16-bit hexadecimal number.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
pppoe False object An optional object containing necessary values for PPPoE configuration. Required only when ipv4 type is PPPoE.
ctsEnabled False boolean A boolean that indicates whether the propagation of Security Group Tag (SGT) is enabled on this interface or not. If this property is not included in the API call or is set to null, then it will default to false unless the interface has a valid name property.
fecMode False string An enum value that specifies the physical interface fec (Forward Error Correction) type where AUTO is default. Applicable to 25G interfaces on FXOS platforms
etherChannelID True integer Unique identifier for the EtherChannel; integer between 1 and 48.
Field level constraints: cannot be null, must be between 1 and 48 (inclusive). (Note: Additional constraints might exist)
memberInterfaces True [object] A set of zero or more physical interfaces that are grouped together to form an EtherChannel.
Field level constraints: cannot be null, size must be between 0 and 16 (inclusive). (Note: Additional constraints might exist)
Allowed types are: [PhysicalInterface]
lacpMode True string The Link Aggregation Control Protocol (LACP) mode of this EtherChannel. Modes supported may depend on your platform; some possible values include ACTIVE (default), PASSIVE and ON.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
speedType True string The speed type of the EtherChannel. Speed types supported may depend on your platform; some possible values include AUTO (default), TEN, HUNDRED, THOUSAND, TEN_THOUSAND, NO_NEGOTIATE, and IGNORE.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
autoNeg False boolean A boolean value to configure auto-negotiation on an EtherChannel. Auto-negotiation values depend on your platform. Values on supported platforms are true/false, but unsupported platforms only use null. Null is equivalent to false.
This config is used to enable/disable InBandAutoneg/CL37 for 1G/100fx modules and to enable/disable link-training and fec negotiation for 25G and above speed copper modules.
duplexType True string The duplex type of the EtherChannel. Duplex types supported may depend on your platform; some possible values include AUTO (default), FULL, and IGNORE.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
tenGigabitInterface False boolean An optional Boolean value, TRUE or FALSE (the default). The TRUE value indicates that the interface is a Ten Gigabit Interface. The value FALSE indicates that the interface is not a Ten Gigabit Interface.
gigabitInterface False boolean An optional Boolean value, TRUE or FALSE (the default). The TRUE value indicates that the interface is a Gigabit Interface. The value FALSE indicates that the interface is not a Gigabit Interface.
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 '{
        "autoNeg": true,
        "ctsEnabled": true,
        "description": "string",
        "duplexType": "AUTO",
        "enabled": true,
        "etherChannelID": 0,
        "fecMode": "AUTO",
        "gigabitInterface": true,
        "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"
        },
        "lacpMode": "ACTIVE",
        "linkState": "UP",
        "macAddress": "string",
        "managementInterface": true,
        "managementOnly": true,
        "memberInterfaces": [
            {
                "id": "string",
                "name": "string",
                "type": "string",
                "version": "string"
            }
        ],
        "mode": "PASSIVE",
        "monitorInterface": true,
        "mtu": 0,
        "name": "string",
        "pppoe": {
            "ipIsDynamic": true,
            "pppAuthType": "PAP",
            "pppoeMetric": 0,
            "pppoePassword": "string",
            "pppoeUser": "string",
            "setRoute": true,
            "type": "pppoverethernet",
            "vpdnGrpName": "string"
        },
        "speedType": "SFP_DETECT",
        "standbyMacAddress": "string",
        "tenGigabitInterface": true,
        "type": "etherchannelinterface",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/devices/default/etherchannelinterfaces"
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_ether_channel_interface(client, body):
    return client.Interface.addEtherChannelInterface(
        body=body
    ).response().result


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

    body = {'autoNeg': True,
 'ctsEnabled': True,
 'description': 'string',
 'duplexType': 'AUTO',
 'enabled': True,
 'etherChannelID': 0,
 'fecMode': 'AUTO',
 'gigabitInterface': True,
 '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'},
 'lacpMode': 'ACTIVE',
 'linkState': 'UP',
 'macAddress': 'string',
 'managementInterface': True,
 'managementOnly': True,
 'memberInterfaces': [{'id': 'string',
                       'name': 'string',
                       'type': 'string',
                       'version': 'string'}],
 'mode': 'PASSIVE',
 'monitorInterface': True,
 'mtu': 0,
 'name': 'string',
 'pppoe': {'ipIsDynamic': True,
           'pppAuthType': 'PAP',
           'pppoeMetric': 0,
           'pppoePassword': 'string',
           'pppoeUser': 'string',
           'setRoute': True,
           'type': 'pppoverethernet',
           'vpdnGrpName': 'string'},
 'speedType': 'SFP_DETECT',
 'standbyMacAddress': 'string',
 'tenGigabitInterface': True,
 'type': 'etherchannelinterface'}

    add_ether_channel_interface(client, body)