Description

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

HTTP request

POST /api/fdm/v6/devices/default/routing/virtualrouters/{vrfId}/ospfinterfacesettings

Data Parameters

Parameter Required Type Description
name True string A string that represents the name of the object
description False string
Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
deviceInterface True object The interface for which ospf settings has to be configured. The interface must not be a BVI interface, member of BVI interface, or be passive, or used in high availability configuration, and should be in enabled state
Field level constraints: cannot be null. (Note: Additional constraints might exist)
Allowed types are: [BridgeGroupInterface, EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
ospfProtocolConfiguration True object Represents the configuration to be made for OSPF protocol
Field level constraints: cannot be null. (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
vrfId True string

Example

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "description": "string",
        "deviceInterface": {
            "id": "string",
            "name": "string",
            "type": "string",
            "version": "string"
        },
        "id": "string",
        "name": "string",
        "ospfProtocolConfiguration": {
            "authentication": {},
            "filterOutgoingLSA": true,
            "ignoreMtuMismatch": true,
            "lostNeighborDetectionMechanism": {},
            "packetCost": 0,
            "priority": 0,
            "ptpNonBroadcast": true,
            "retransmitInterval": 0,
            "transmitDelay": 0,
            "type": "ospfprotocolconfiguration"
        },
        "type": "ospfinterfacesettings",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/devices/default/routing/virtualrouters/{vrfId}/ospfinterfacesettings"
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_ospf_interface_settings(client, vrf_id, body):
    return client.OSPFInterfaceSettings.addOSPFInterfaceSettings(
        vrfId=vrf_id,
        body=body
    ).response().result


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

    vrf_id = "string"
    body = {'description': 'string',
 'deviceInterface': {'id': 'string',
                     'name': 'string',
                     'type': 'string',
                     'version': 'string'},
 'name': 'string',
 'ospfProtocolConfiguration': {'authentication': {},
                               'filterOutgoingLSA': True,
                               'ignoreMtuMismatch': True,
                               'lostNeighborDetectionMechanism': {},
                               'packetCost': 0,
                               'priority': 0,
                               'ptpNonBroadcast': True,
                               'retransmitInterval': 0,
                               'transmitDelay': 0,
                               'type': 'ospfprotocolconfiguration'},
 'type': 'ospfinterfacesettings'}

    add_ospf_interface_settings(client, vrf_id, body)