HardwareBypass
Description
An object specifying hardware bypass and its properties. (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)
Supported Operations
Model Properties
| Property | 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 | |||