Description

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

HTTP request

PUT /api/fdm/v6/devices/default/routing/virtualrouters/{objId}

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 True string Name of the VRF
isSystemDefined True boolean A Boolean value, TRUE or FALSE(the default). The TRUE value indicates that this VRF object is a system defined object with name as Global
Field level constraints: cannot be null. (Note: Additional constraints might exist)
description False string An optional description of this VRF
Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
interfaces False [object] Interfaces which will operate under the specific VRF context
Allowed types are: [BridgeGroupInterface, EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
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 virtualrouter

Path Parameters

Parameter Required Type Description
objId True string

Example

curl -X PUT \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "description": "string",
        "id": "string",
        "interfaces": [],
        "isSystemDefined": true,
        "name": "string",
        "type": "virtualrouter",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/devices/default/routing/virtualrouters/{objId}"
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 edit_virtual_router(client, obj_id, body):
    return client.Routing.editVirtualRouter(
        objId=obj_id,
        body=body
    ).response().result


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

    obj_id = "string"
    body = {'description': 'string',
 'id': 'string',
 'interfaces': [],
 'isSystemDefined': True,
 'name': 'string',
 'type': 'virtualrouter',
 'version': 'string'}

    edit_virtual_router(client, obj_id, body)