Description

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

HTTP request

POST /api/fdm/v6/action/breakoutinterface

Data Parameters

Parameter Required Type Description
breakoutInterface True object
Allowed types are: [PhysicalInterface]
interfaces False [object] A read-only field which will return a list of split interfaces after a breakout has occured.
Field level constraints: size must be between 0 and 4 (inclusive). (Note: Additional constraints might exist)
Allowed types are: [PhysicalInterface]
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.

Example

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "breakoutInterface": {
            "id": "string",
            "name": "string",
            "type": "string",
            "version": "string"
        },
        "id": "string",
        "interfaces": [],
        "type": "breakoutinterface"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/action/breakoutinterface"
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 breakoutinterface(client, body):
    return client.Interface.breakoutinterface(
        body=body
    ).response().result


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

    body = {'breakoutInterface': {'id': 'string',
                       'name': 'string',
                       'type': 'string',
                       'version': 'string'},
 'id': 'string',
 'interfaces': [],
 'type': 'breakoutinterface'}

    breakoutinterface(client, body)