Deployment_Info

Deployment_Info
Deployment_Info

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

JSON Example
{
    "state": "string",
    "progress": {
        "total": 0,
        "completed": 0,
        "message": {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    },
    "subtask_order": [
        "string"
    ],
    "subtasks": {
        "subtasks": {
            "progress": "Task_Progress Object",
            "result": {
                "info": [
                    {
                        "id": "string",
                        "time": "string",
                        "message": "Std_LocalizableMessage Object",
                        "resolution": "Std_LocalizableMessage Object"
                    }
                ],
                "warnings": [
                    {
                        "id": "string",
                        "time": "string",
                        "message": "Std_LocalizableMessage Object",
                        "resolution": "Std_LocalizableMessage Object"
                    }
                ],
                "errors": [
                    {
                        "id": "string",
                        "time": "string",
                        "message": "Std_LocalizableMessage Object",
                        "resolution": "Std_LocalizableMessage Object"
                    }
                ]
            },
            "description": "Std_LocalizableMessage Object",
            "service": "string",
            "operation": "string",
            "parent": "string",
            "target": {
                "type": "string",
                "id": "string"
            },
            "status": "string",
            "cancelable": false,
            "error": {},
            "start_time": "string",
            "end_time": "string",
            "user": "string"
        }
    },
    "description": "Std_LocalizableMessage Object",
    "service": "string",
    "operation": "string",
    "parent": "string",
    "target": {
        "type": "string",
        "id": "string"
    },
    "status": "string",
    "cancelable": false,
    "error": {},
    "start_time": "string",
    "end_time": "string",
    "user": "string"
}
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.

progress
Optional

The Progress structure contains information describe the progress of an operation.

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.

object
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.

description
Required

The LocalizableMessage structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.

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.

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.

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.

target
Optional

The DynamicID structure represents an identifier for a resource of an arbitrary type.

status
Required

The Status enumerated type defines the status values that can be reported for an operation.
PENDING : The operation is in pending state.
RUNNING : The operation is in progress.
BLOCKED : The operation is blocked.
SUCCEEDED : The operation completed successfully.
FAILED : The operation failed.

boolean
cancelable
Required

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

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
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.

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.

string
user
Optional

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