DeploymentInfo

The Deployment.Info structure contains fields to describe the state of the appliance.


Properties

string
service Required

Identifier of the service containing the operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.service.


description Required

Description of the operation associated with the task.


status Required

Status of the operation associated with the task.


state Required

The ApplianceState enumerated type defines the various states the vCenter Appliance can be in.
NOT_INITIALIZED : The appliance is in the process of being initialized and not ready for configuration.
INITIALIZED : The appliance is initialized and ready to be configured.
CONFIG_IN_PROGRESS : The appliance is in the process of being configured.
QUESTION_RAISED : The deployment script has raised a question and is waiting for an answer to continue with the appliance configuration.
FAILED : The appliance configuration has failed.
CONFIGURED : The appliance has been configured.

Possible values are: NOT_INITIALIZEDINITIALIZEDCONFIG_IN_PROGRESSQUESTION_RAISEDFAILEDCONFIGURED


string
operation Required

Identifier of the operation associated with the task. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.operation.


boolean
cancelable Required

Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.


progress Optional

The progress info of the current appliance status. This field is optional and it is only relevant when the value of CommonInfo#status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.


string
parent Optional

Parent of the current task. This field will be unset if the task has no parent. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.task. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.task.


string as date-time
start_time Optional

Time when the operation is started. This field is optional and it is only relevant when the value of CommonInfo.status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.


object
error Optional

Description of the error if the operation status is “FAILED”. If unset the description of why the operation failed will be included in the result of the operation (see Info.result).


string as date-time
end_time Optional

Time when the operation is completed. This field is optional and it is only relevant when the value of CommonInfo.status is one of SUCCEEDED or FAILED.


array of string
subtask_order Optional

The ordered list of subtasks for this deployment operation. Only set when the appliance state is RUNNING_IN_PROGRESS, FAILED, CANCELLED and SUCCEEDED.


subtasks Optional

The map of the deployment subtasks and their status infomation. Only set when the appliance state is RUNNING_IN_PROGRESS, FAILED, CANCELLED and SUCCEEDED.


target Optional

Identifier of the target created by the operation or an existing one the operation performed on. This field will be unset if the operation has no target or multiple targets.


string
user Optional

Name of the user who performed the operation. This field will be unset if the operation is performed by the system.

JSON Example

{
	"cancelable": false,
	"description": {
		"args": [
			"string"
		],
		"default_message": "string",
		"id": "string"
	},
	"operation": "string",
	"service": "string",
	"state": "NOT_INITIALIZED",
	"status": "enum"
}
Returned By

Get Deployment

Feedback

Was this page helpful?