REST API - get

vcenter deployment: get

Get the current status of the appliance deployment. This operation was added in vSphere API 6.7

Request:

HTTP request

GET https://{server}/rest/vcenter/deployment

No request parameters

Response:

HTTP Status Code: 200

Representation:

JSON

{
    "value": {
        "cancelable": true,
        "description": {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        },
        "end_time": "2015-01-01T22:13:05.651Z",
        "error": {},
        "operation": "obj-103",
        "parent": "obj-103",
        "progress": {
            "completed": 1,
            "message": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "total": 1
        },
        "service": "obj-103",
        "start_time": "2015-01-01T22:13:05.651Z",
        "state": "NOT_INITIALIZED",
        "status": "PENDING",
        "subtask_order": [
            "string",
            "string"
        ],
        "subtasks": [
            {
                "key": "string",
                "value": {
                    "cancelable": true,
                    "description": {
                        "args": [
                            "string",
                            "string"
                        ],
                        "default_message": "string",
                        "id": "string"
                    },
                    "end_time": "2015-01-01T22:13:05.651Z",
                    "error": {},
                    "operation": "obj-103",
                    "parent": "obj-103",
                    "progress": {
                        "completed": 1,
                        "message": {
                            "args": [
                                "string",
                                "string"
                            ],
                            "default_message": "string",
                            "id": "string"
                        },
                        "total": 1
                    },
                    "result": {
                        "errors": [
                            {
                                "id": "string",
                                "message": {
                                    "args": [
                                        "string",
                                        "string"
                                    ],
                                    "default_message": "string",
                                    "id": "string"
                                },
                                "resolution": {
                                    "args": [
                                        "string",
                                        "string"
                                    ],
                                    "default_message": "string",
                                    "id": "string"
                                },
                                "time": "2015-01-01T22:13:05.651Z"
                            },
                            {
                                "id": "string",
                                "message": {
                                    "args": [
                                        "string",
                                        "string"
                                    ],
                                    "default_message": "string",
                                    "id": "string"
                                },
                                "resolution": {
                                    "args": [
                                        "string",
                                        "string"
                                    ],
                                    "default_message": "string",
                                    "id": "string"
                                },
                                "time": "2015-01-01T22:13:05.651Z"
                            }
                        ],
                        "info": [
                            {
                                "id": "string",
                                "message": {
                                    "args": [
                                        "string",
                                        "string"
                                    ],
                                    "default_message": "string",
                                    "id": "string"
                                },
                                "resolution": {
                                    "args": [
                                        "string",
                                        "string"
                                    ],
                                    "default_message": "string",
                                    "id": "string"
                                },
                                "time": "2015-01-01T22:13:05.651Z"
                            },
                            {
                                "id": "string",
                                "message": {
                                    "args": [
                                        "string",
                                        "string"
                                    ],
                                    "default_message": "string",
                                    "id": "string"
                                },
                                "resolution": {
                                    "args": [
                                        "string",
                                        "string"
                                    ],
                                    "default_message": "string",
                                    "id": "string"
                                },
                                "time": "2015-01-01T22:13:05.651Z"
                            }
                        ],
                        "warnings": [
                            {
                                "id": "string",
                                "message": {
                                    "args": [
                                        "string",
                                        "string"
                                    ],
                                    "default_message": "string",
                                    "id": "string"
                                },
                                "resolution": {
                                    "args": [
                                        "string",
                                        "string"
                                    ],
                                    "default_message": "string",
                                    "id": "string"
                                },
                                "time": "2015-01-01T22:13:05.651Z"
                            },
                            {
                                "id": "string",
                                "message": {
                                    "args": [
                                        "string",
                                        "string"
                                    ],
                                    "default_message": "string",
                                    "id": "string"
                                },
                                "resolution": {
                                    "args": [
                                        "string",
                                        "string"
                                    ],
                                    "default_message": "string",
                                    "id": "string"
                                },
                                "time": "2015-01-01T22:13:05.651Z"
                            }
                        ]
                    },
                    "service": "obj-103",
                    "start_time": "2015-01-01T22:13:05.651Z",
                    "status": "PENDING",
                    "target": {
                        "id": "obj-103",
                        "type": "string"
                    },
                    "user": "string"
                }
            }
        ],
        "target": {
            "id": "obj-103",
            "type": "string"
        },
        "user": "string"
    }
}

Response Type:

Name	Type	Description
bold = required
value	info	Info structure containing the status information about the appliance.
value.state	string	State of the vCenter Server Appliance. This attribute was added in vSphere API 6.7 Defines the various states the vCenter Appliance can be in. This enumeration was added in vSphere API 6.7 Value is one of: NOT_INITIALIZED: The appliance is in the process of being initialized and not ready for configuration. This constant was added in vSphere API 6.7 INITIALIZED: The appliance is initialized and ready to be configured. This constant was added in vSphere API 6.7 CONFIG_IN_PROGRESS: The appliance is in the process of being configured. This constant was added in vSphere API 6.7 QUESTION_RAISED: The deployment script has raised a question and is waiting for an answer to continue with the appliance configuration. This constant was added in vSphere API 6.7 FAILED: The appliance configuration has failed. This constant was added in vSphere API 6.7 CONFIGURED: The appliance has been configured. This constant was added in vSphere API 6.7
value.progress	progress	The progress info of the current appliance status. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of `#status` is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.
value.progress.total	long	Total amount of the work for the operation. This attribute was added in vSphere API 6.7
value.progress.completed	long	The amount of work completed for the operation. The value can only be incremented. This attribute was added in vSphere API 6.7
value.progress.message	localizable_message	Message about the work progress. This attribute was added in vSphere API 6.7
value.progress.message.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.progress.message.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.progress.message.args	string[]	Arguments to be substituted into a message template.
value.subtask_order	string[]	The ordered list of subtasks for this deployment operation. This attribute was added in vSphere API 6.7 Optional. Only set when the appliance state is RUNNING_IN_PROGRESS, FAILED, CANCELLED and SUCCEEDED.
value.subtasks	list	The map of the deployment subtasks and their status infomation. This attribute was added in vSphere API 6.7 Optional. Only set when the appliance state is RUNNING_IN_PROGRESS, FAILED, CANCELLED and SUCCEEDED.
value.subtasks[].key	string
value.subtasks[].value	task
value.subtasks[].value.progress	progress	The progress info of this deployment task. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of `#status` is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.
value.subtasks[].value.progress.total	long	Total amount of the work for the operation. This attribute was added in vSphere API 6.7
value.subtasks[].value.progress.completed	long	The amount of work completed for the operation. The value can only be incremented. This attribute was added in vSphere API 6.7
value.subtasks[].value.progress.message	localizable_message	Message about the work progress. This attribute was added in vSphere API 6.7
value.subtasks[].value.progress.message.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.subtasks[].value.progress.message.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.subtasks[].value.progress.message.args	string[]	Arguments to be substituted into a message template.
value.subtasks[].value.result	notifications	Result of the task. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field will be unset if result is not available at the current step of the task.
value.subtasks[].value.result.info	notification[]	Info notification messages reported. This attribute was added in vSphere API 6.7 Optional. Only set if an info was reported by the task.
value.subtasks[].value.result.info[].id	string	The notification id. This attribute was added in vSphere API 6.7
value.subtasks[].value.result.info[].time	date_time	The time the notification was raised/found. This attribute was added in vSphere API 6.7 Optional. Only set if the time information is available.
value.subtasks[].value.result.info[].message	localizable_message	The notification message. This attribute was added in vSphere API 6.7
value.subtasks[].value.result.info[].message.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.subtasks[].value.result.info[].message.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.subtasks[].value.result.info[].message.args	string[]	Arguments to be substituted into a message template.
value.subtasks[].value.result.info[].resolution	localizable_message	The resolution message, if any. This attribute was added in vSphere API 6.7 Optional. Only set for warnings and errors.
value.subtasks[].value.result.info[].resolution.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.subtasks[].value.result.info[].resolution.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.subtasks[].value.result.info[].resolution.args	string[]	Arguments to be substituted into a message template.
value.subtasks[].value.result.warnings	notification[]	Warning notification messages reported. This attribute was added in vSphere API 6.7 Optional. Only set if an warning was reported by the task.
value.subtasks[].value.result.warnings[].id	string	The notification id. This attribute was added in vSphere API 6.7
value.subtasks[].value.result.warnings[].time	date_time	The time the notification was raised/found. This attribute was added in vSphere API 6.7 Optional. Only set if the time information is available.
value.subtasks[].value.result.warnings[].message	localizable_message	The notification message. This attribute was added in vSphere API 6.7
value.subtasks[].value.result.warnings[].message.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.subtasks[].value.result.warnings[].message.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.subtasks[].value.result.warnings[].message.args	string[]	Arguments to be substituted into a message template.
value.subtasks[].value.result.warnings[].resolution	localizable_message	The resolution message, if any. This attribute was added in vSphere API 6.7 Optional. Only set for warnings and errors.
value.subtasks[].value.result.warnings[].resolution.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.subtasks[].value.result.warnings[].resolution.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.subtasks[].value.result.warnings[].resolution.args	string[]	Arguments to be substituted into a message template.
value.subtasks[].value.result.errors	notification[]	Error notification messages reported. This attribute was added in vSphere API 6.7 Optional. Only set if an error was reported by the task.
value.subtasks[].value.result.errors[].id	string	The notification id. This attribute was added in vSphere API 6.7
value.subtasks[].value.result.errors[].time	date_time	The time the notification was raised/found. This attribute was added in vSphere API 6.7 Optional. Only set if the time information is available.
value.subtasks[].value.result.errors[].message	localizable_message	The notification message. This attribute was added in vSphere API 6.7
value.subtasks[].value.result.errors[].message.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.subtasks[].value.result.errors[].message.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.subtasks[].value.result.errors[].message.args	string[]	Arguments to be substituted into a message template.
value.subtasks[].value.result.errors[].resolution	localizable_message	The resolution message, if any. This attribute was added in vSphere API 6.7 Optional. Only set for warnings and errors.
value.subtasks[].value.result.errors[].resolution.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.subtasks[].value.result.errors[].resolution.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.subtasks[].value.result.errors[].resolution.args	string[]	Arguments to be substituted into a message template.
value.subtasks[].value.description	localizable_message	Description of the operation associated with the task. This attribute was added in vSphere API 6.7
value.subtasks[].value.description.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.subtasks[].value.description.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.subtasks[].value.description.args	string[]	Arguments to be substituted into a message template.
value.subtasks[].value.service	string	Name of the service containing the operation. This attribute was added in vSphere API 6.7 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`.
value.subtasks[].value.operation	string	Name of the operation associated with the task. This attribute was added in vSphere API 6.7 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`.
value.subtasks[].value.parent	string	Parent of the current task. This attribute was added in vSphere API 6.7 Optional. 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`.
value.subtasks[].value.target	dynamic_ID	Identifier of the target created by the operation or an existing one the operation performed on. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the operation has no target or multiple targets.
value.subtasks[].value.target.type	string	The type of resource being identified (for example `com.acme.Person`). Services that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata services include a service that allows retrieving all the known resource types.
value.subtasks[].value.target.id	string	The identifier for a resource whose type is specified by vapi.std.dynamic_ID.type. When clients pass a value of this structure as a parameter, the field `type` must contain the actual resource type. When operations return a value of this structure as a result, the field `type` will contain the actual resource type.
value.subtasks[].value.status	string	Status of the operation associated with the task. This attribute was added in vSphere API 6.7 Defines the status values that can be reported for an operation. This enumeration was added in vSphere API 6.7 Value is one of: PENDING: The operation is in pending state. This constant was added in vSphere API 6.7 RUNNING: The operation is in progress. This constant was added in vSphere API 6.7 BLOCKED: The operation is blocked. This constant was added in vSphere API 6.7 SUCCEEDED: The operation completed successfully. This constant was added in vSphere API 6.7 FAILED: The operation failed. This constant was added in vSphere API 6.7
value.subtasks[].value.cancelable	boolean	Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. This attribute was added in vSphere API 6.7
value.subtasks[].value.error	exception	Description of the error if the operation status is "FAILED". This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [FAILED]. If unset the description of why the operation failed will be included in the result of the operation (see cis.task.info.result).
value.subtasks[].value.start_time	date_time	Time when the operation is started. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of `status` is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.
value.subtasks[].value.end_time	date_time	Time when the operation is completed. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of `status` is one of SUCCEEDED or FAILED.
value.subtasks[].value.user	string	Name of the user who performed the operation. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the operation is performed by the system.
value.description	localizable_message	Description of the operation associated with the task. This attribute was added in vSphere API 6.7
value.description.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.description.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.description.args	string[]	Arguments to be substituted into a message template.
value.service	string	Name of the service containing the operation. This attribute was added in vSphere API 6.7 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`.
value.operation	string	Name of the operation associated with the task. This attribute was added in vSphere API 6.7 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`.
value.parent	string	Parent of the current task. This attribute was added in vSphere API 6.7 Optional. 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`.
value.target	dynamic_ID	Identifier of the target created by the operation or an existing one the operation performed on. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the operation has no target or multiple targets.
value.target.type	string	The type of resource being identified (for example `com.acme.Person`). Services that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata services include a service that allows retrieving all the known resource types.
value.target.id	string	The identifier for a resource whose type is specified by vapi.std.dynamic_ID.type. When clients pass a value of this structure as a parameter, the field `type` must contain the actual resource type. When operations return a value of this structure as a result, the field `type` will contain the actual resource type.
value.status	string	Status of the operation associated with the task. This attribute was added in vSphere API 6.7 Defines the status values that can be reported for an operation. This enumeration was added in vSphere API 6.7 Value is one of: PENDING: The operation is in pending state. This constant was added in vSphere API 6.7 RUNNING: The operation is in progress. This constant was added in vSphere API 6.7 BLOCKED: The operation is blocked. This constant was added in vSphere API 6.7 SUCCEEDED: The operation completed successfully. This constant was added in vSphere API 6.7 FAILED: The operation failed. This constant was added in vSphere API 6.7
value.cancelable	boolean	Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. This attribute was added in vSphere API 6.7
value.error	exception	Description of the error if the operation status is "FAILED". This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [FAILED]. If unset the description of why the operation failed will be included in the result of the operation (see cis.task.info.result).
value.start_time	date_time	Time when the operation is started. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of `status` is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.
value.end_time	date_time	Time when the operation is completed. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of `status` is one of SUCCEEDED or FAILED.
value.user	string	Name of the user who performed the operation. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the operation is performed by the system.

Errors:

HTTP Status Code	Type	Description
401	unauthenticated	if the caller is not authenticated.
404	not_found	if appliance state cannot be determined.