JoinHAStatus

Description

A singleton object that persists information about a join 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
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 millisecond (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 False 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