upsertHardwareBypass

The upsertHardwareBypass operation handles configuration related to HardwareBypass model.

Description

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

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

Query Parameters

Parameter	Required	Type	Description
filter	False	string	The criteria used to filter the models you are requesting. It should have the following format: {key}{operator}{value}[;{key}{operator}{value}]. Supported operators are: "!"(not equals), ":"(equals), "~"(similar). Supported keys are: "name", "fts". The "fts" filter cannot be used with other filters. Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertHardwareBypass' operation
  ftd_configuration:
    operation: "upsertHardwareBypass"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        bypassPair: "{{ bypass_pair }}"
        bypassPowerDown: "{{ bypass_power_down }}"
        bypassImmediately: "{{ bypass_immediately }}"
        interfaces: "{{ interfaces }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"