BreakHAStatus
Description
A singleton object that persists information about a break HA deployment in progress. If no deployment is in progress, the object will contain information about the most recently executed deployment. (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 | |||
|---|---|---|---|---|---|---|
| interfaceOption | False | string | An enum value that specifies how interfaces should be handled after HA break on the active and standby nodes. This attribute is optional when used on the active node, but required when used on a non-active node. If you use this on the active node when the devices are in a healthy active/standby state, this attribute applies to the interfaces on the standby node. In any other state, such as active/active or suspended, the attribute applies to the node on which you initiate the break. | |||
| Possible values are: | ||||||
-DISABLE_INTERFACES (the default). All data interfaces on the standby device (or this device) are disabled. |
||||||
-ENABLE_WITH_STANDBY_IP. If you configured a standby IP address for an interface, the interface on the standby device (or this device) is reconfigured to use the standby address. Any interface that lacks a standby address is disabled. |
||||||
| statusMessage | False | string | A string that contains all deployment status messages | |||
| cliErrorMessage | False | string | An error message returned from the configuration CLI. | |||
| state | False | string | The current deployment state. | |||
| queuedTime | False | integer | The time in milliseconds (UNIX Epoch Time) when the deployment was scheduled. | |||
| startTime | False | integer | The time in milliseconds (UNIX Epoch time) when the deployment was started | |||
| endTime | False | integer | The time in milliseconds (UNIX Epoch Time) when the deployment completed. | |||
| statusMessages | False | [string] | A list of messages that show deployment status. | |||
| 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) |
|||
| name | False | string | Field level constraints: length must be between 0 and 128 (inclusive), must match pattern (^[a-zA-Z0-9_]$)|(^[a-zA-Z0-9_][ a-zA-Z0-9_.()/+-]*[a-zA-Z0-9_.)+-]$). (Note: Additional constraints might exist) |
|||
| modifiedObjects | False | object | The modified objects in this deployment | |||
| type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. | |||
| forceRefreshDeploymentData | False | boolean | A flag that makes deployment regenerate all CLI and Snort configurations. Cannot be enabled for this deployment type | |||