REST API - execute_status
  1. Operations
  2. vcenter
  3. nsx
  4. recovery

vcenter nsx recovery: execute status

Gets the recovery status. 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/recovery/execute/status

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "start_time" : "2015-01-01T22:13:05.651Z",
    "stage" : "NONE",
    "warnings" : [
        {
            "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" : {}
                                }
                            }
                        }
                    }
                }
            }
        },
        {
            "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" : {}
                                }
                            }
                        }
                    }
                }
            }
        }
    ],
    "end_time" : "2015-01-01T22:13:05.651Z",
    "errors" : [
        {
            "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" : {}
                                }
                            }
                        }
                    }
                }
            }
        },
        {
            "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" : {}
                                }
                            }
                        }
                    }
                }
            }
        }
    ]
}

Headers:

None

Type:

Name Type Description
bold = required
- execution_status Returns an ExecutionStatus.
-.stage string Stage of the recovery operation. 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.

Defines the stage of the NSX infrastructure recovery operation. 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:
NONE: Recovery operation is not 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.
SERVICE_ACCOUNT_PASSWD_RESET: Recovery operation is resetting the service account password. 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.
NSX_LOCATE: Recovery operation is locating the NSX-I VM. 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.
NSX_INSTALL: Recovery operation is creating NSX infrastructure for WCP clusters. 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.
PREPARE_NSXD: Recovery operation is preparing NSXd for recovery. 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.
DONE: Recovery operation is complete. 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.
-.errors localizable_message[] Error that occurred during the recovery operation. This error does not represent any error that occurs while recovering the NSX infrastructure. 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. If unset, no error occurred.
-.errors[].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.
-.errors[].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.
-.errors[].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.
-.warnings localizable_message[] Warnings that occurred during the recovery operation. 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. If unset, no warnings occurred.
-.start_time date_time Start time of the recovery operation. 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.
-.end_time date_time End time of the recovery operation. It can be unspecified if the recovery operation is in progress. 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.

Errors:

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