Description

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

This feature is supported only on hyperlite platform - Cisco ISA-3000-4C-X Threat Defense, Cisco ISA-3000-2C2F-X Threat Defense, Cisco 1783-SAD4T0S-X Threat Defense, Cisco 1783-SAD2T2S-X Threat Defense

HTTP request

PUT /api/fdm/v6/devices/default/hardwarebypassinterfacepairs/{objId}

Data Parameters

Parameter Required Type Description
version False string Current version of the object
name False string HardwareBypass
bypassPair False string Name of the hardware bypass pair
bypassPowerDown False string An enum value that configures power down bypass.
BYPASS_POWERDOWN - Enables the bypass power down.
BYPASS_POWERDOWN_PERSIST - Enables bypass power down with sticky or persistence.
DISABLE_BYPASS_POWERDOWN - Disables the bypass power down.
bypassImmediately False boolean A boolean value that enables or disables hardware bypass manually. Specify true to put the interface pair into bypass mode. Specify false to disable hardware bypass and return to normal operations
interfaces False [object] A list of the interfaces that form the bypass pair
Allowed types are: [PhysicalInterface]
id False string Unique ID of the object
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string HardwareBypass

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 '{
        "bypassImmediately": true,
        "bypassPair": "INTERFACEPAIR1_2",
        "bypassPowerDown": "BYPASS_POWERDOWN",
        "id": "string",
        "interfaces": [],
        "name": "string",
        "type": "hardwarebypass",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/devices/default/hardwarebypassinterfacepairs/{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_hardware_bypass(client, obj_id, body):
    return client.HardwareBypass.editHardwareBypass(
        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 = {'bypassImmediately': True,
 'bypassPair': 'INTERFACEPAIR1_2',
 'bypassPowerDown': 'BYPASS_POWERDOWN',
 'id': 'string',
 'interfaces': [],
 'name': 'string',
 'type': 'hardwarebypass',
 'version': 'string'}

    edit_hardware_bypass(client, obj_id, body)