Status

Description

Publish a progress status message via the framework.

Parameters

Parameter Name	Description	Type	Resolved Type	Required
Type	The high level status type. This can be any of the following values: Success Failure Connecting Checking Changing PasswordMismatch, HostKeyMismatch, ServiceChangePasswordSuccess, ServiceChangePasswordFailure, ServiceRestartSuccess ServiceRestartFailure TaskChangePasswordSuccess TaskChangePasswordFailure AuthorizedKeyMismatch Discovering	string	Enum (StatusType)	Yes
Percent	approximate indication of progress as a percentage	Integer	Integer	Yes
Message	The message object to publish, see below	object	Message	n/a

Types

Message

Parameter Name	Description	Type	Resolved Type	Required
Name	The symbolic name that represents a status message in the status string resource. This must be one of the predefined status message ids defined in Predefined Status Message List	String	Enum (MessageId)	Yes
Parameters	The list of expected parameters to format the message identified by Name.	Array	Array	No

Examples

Example:

{
  "Status": {
    "Type": "Checking",
    "Percent": 10,
    "Message": {
      "Name": "AssetTestingConnectionWithAddress",
      "Parameters": [ "Asset Name", "Asset Address" ]
    }
  }
}