REST API - get
  1. Operations
  2. vcenter
  3. nsx
  4. clusters
  5. status

vcenter nsx clusters status: get

Return the status of NSX configuration on the cluster. 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/clusters/{cluster}/status

Path Parameters

Name Type Description
Required
cluster string Identifier for the cluster compute resource enabled for NSX networking.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "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" : {}
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    ],
    "status" : "ENABLING"
}

Headers:

None

Type:

Name Type Description
bold = required
- info Information about the NSX networking configuration status of the cluster.
-.status string NSX networking configuration status of the cluster. 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 configuring NSX networking on the cluster compute resource. 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:
ENABLING: The NSX networking configuration is being applied to the cluster. 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.
RUNNING: The cluster is configured successfully with NSX networking. 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: Failed to apply the NSX networking configuration on the cluster. 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 message[] List of messages associated with the NSX networking configuration of the cluster. This list will be empty unless the NSX networking configuration of the cluster failed. 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[].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. 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. 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. 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.

Errors:

HTTP Status Code Type Description
404 not_found if cluster is not a valid identifier for a compute resource configured for NSX networking.
500 error if the system reports an error while responding to the request.