REST API - get
  1. Operations
  2. vcenter
  3. nsx
  4. deployment
  5. install

vcenter nsx deployment install: get

Gets the NSX appliance deployment status on the current vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/vcenter/nsx/deployment/install

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "phase" : "PRECHECK",
    "start_time" : "2015-01-01T22:13:05.651Z",
    "end_time" : "2015-01-01T22:13:05.651Z",
    "messages" : [
        {
            "severity" : "INFO",
            "details" : {
                "args" : [
                    "string",
                    "string"
                ],
                "default_message" : "string",
                "localized" : "string",
                "id" : "string",
                "params" : {
                    "<string>" : {
                        "dt" : "2015-01-01T22:13:05.651Z",
                        "s" : "string",
                        "d" : 1.5,
                        "precision" : 1,
                        "format" : "SHORT_DATE",
                        "i" : 1,
                        "l" : {
                            "id" : "string",
                            "params" : {
                                "<string>" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : {}
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        {
            "severity" : "INFO",
            "details" : {
                "args" : [
                    "string",
                    "string"
                ],
                "default_message" : "string",
                "localized" : "string",
                "id" : "string",
                "params" : {
                    "<string>" : {
                        "dt" : "2015-01-01T22:13:05.651Z",
                        "s" : "string",
                        "d" : 1.5,
                        "precision" : 1,
                        "format" : "SHORT_DATE",
                        "i" : 1,
                        "l" : {
                            "id" : "string",
                            "params" : {
                                "<string>" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : {}
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    ],
    "progress" : 1.5,
    "operation" : "INSTALL",
    "status" : "NOT_STARTED"
}

Headers:

None

Type:

Name Type Description
bold = required
- info Returns an Info containing information about the last deployment operation which has been run.
-.status string Current status of the NSXi installation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Describes the status of NSX deployment. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
NOT_STARTED: NSX install has not started. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
IN_PROGRESS: NSX deployment is in progress. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
SUCCEEDED: NSX is successfully configured on the vCenter Server. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
FAILED: NSX deployment has failed. Retry the deployment after resolving the errors. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PENDING_CANCEL: NSX deployment was cancelled by the user. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
CANCELLED: NSX deployment has been successfully cancelled. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.operation string The ongoing operation for which we are querying the Status,. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Describes the operation in progress. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
INSTALL: Install the NSX appliance on the vCenter. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
UNINSTALL: Uninstall the NSX appliance on the vCenter. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.Optional. It is only relevant when status has value [SUCCEEDED, FAILED, IN_PROGRESS, PENDING_CANCEL, CANCELLED]. This field is optional and it is only relevant when the value of status is one of SUCCEEDED, FAILED, IN_PROGRESS, PENDING_CANCEL, or CANCELLED.
-.phase string Current phase of the NSXi installation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value [SUCCEEDED, FAILED, IN_PROGRESS, PENDING_CANCEL, CANCELLED]. If unset, no distinct phases in the operation.
-.messages message[] Current set of messages associated with the ongoing deployment. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value [SUCCEEDED, FAILED, IN_PROGRESS, PENDING_CANCEL, CANCELLED]. If unset, no messages available to show.
-.messages[].severity string Type of the message. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Represents the severity of the message. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
INFO: Informational message. This may be accompanied by vCenter event. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
WARNING: Warning message. This may be accompanied by vCenter event. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
ERROR: Error message. This is accompanied by vCenter event and/or alarm. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.messages[].details localizable_message Details about the message. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.messages[].details.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.
-.messages[].details.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.
-.messages[].details.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.
-.progress double Shows the progress of the install operation, expected value is in range [0, 100]. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.start_time date_time Time when operation started. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value [SUCCEEDED, FAILED, IN_PROGRESS, PENDING_CANCEL, CANCELLED]. This field is optional and it is only relevant when the value of status is one of SUCCEEDED, FAILED, IN_PROGRESS, PENDING_CANCEL, or CANCELLED.
-.end_time date_time Time when operation ended. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value [SUCCEEDED, FAILED, CANCELLED]. This field is optional and it is only relevant when the value of status is one of SUCCEEDED, FAILED, or CANCELLED.

Errors:

HTTP Status Code Type Description
500 error for any other unspecified error.
404 not_found if the resource cannot be queried.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user is not a member of the Administrators group.