1. Types
  2. vcenter
  3. nsx
  4. deployment
  5. upgrade

vcenter nsx deployment upgrade: cluster info

The cluster_info structure contains information about the cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Representation:

{
    "number_of_edges_upgraded" : 1,
    "number_of_hosts" : 1,
    "number_of_hosts_upgraded" : 1,
    "number_of_edges" : 1,
    "current_version" : "string",
    "progress" : 1.5,
    "messages" : [
        {
            "unit_name" : "string",
            "msg" : {
                "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" : {}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "msg_type" : "INFO",
            "unit_type" : "MANAGER"
        },
        {
            "unit_name" : "string",
            "msg" : {
                "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" : {}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "msg_type" : "INFO",
            "unit_type" : "MANAGER"
        }
    ],
    "id" : "obj-103",
    "display_name" : "string",
    "display_status" : "NOT_STARTED"
}
{
    "number_of_edges_upgraded" : 1,
    "number_of_hosts" : 1,
    "number_of_hosts_upgraded" : 1,
    "number_of_edges" : 1,
    "current_version" : "string",
    "progress" : 1.5,
    "messages" : [
        {
            "unit_name" : "string",
            "msg" : {
                "args" : [
                    "string",
                    "string"
                ],
                "default_message" : "string",
                "localized" : "string",
                "id" : "string",
                "params" : [
                    {
                        "value" : {
                            "dt" : "2015-01-01T22:13:05.651Z",
                            "s" : "string",
                            "d" : 1.5,
                            "precision" : 1,
                            "format" : "SHORT_DATE",
                            "i" : 1,
                            "l" : {
                                "id" : "string",
                                "params" : [
                                    {
                                        "value" : {
                                            "dt" : "2015-01-01T22:13:05.651Z",
                                            "s" : "string",
                                            "d" : 1.5,
                                            "precision" : 1,
                                            "format" : "SHORT_DATE",
                                            "i" : 1,
                                            "l" : {
                                                "id" : "string",
                                                "params" : [
                                                    {
                                                        "key" : "string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key" : "string"
                                    }
                                ]
                            }
                        },
                        "key" : "string"
                    }
                ]
            },
            "msg_type" : "INFO",
            "unit_type" : "MANAGER"
        },
        {
            "unit_name" : "string",
            "msg" : {
                "args" : [
                    "string",
                    "string"
                ],
                "default_message" : "string",
                "localized" : "string",
                "id" : "string",
                "params" : [
                    {
                        "value" : {
                            "dt" : "2015-01-01T22:13:05.651Z",
                            "s" : "string",
                            "d" : 1.5,
                            "precision" : 1,
                            "format" : "SHORT_DATE",
                            "i" : 1,
                            "l" : {
                                "id" : "string",
                                "params" : [
                                    {
                                        "value" : {
                                            "dt" : "2015-01-01T22:13:05.651Z",
                                            "s" : "string",
                                            "d" : 1.5,
                                            "precision" : 1,
                                            "format" : "SHORT_DATE",
                                            "i" : 1,
                                            "l" : {
                                                "id" : "string",
                                                "params" : [
                                                    {
                                                        "key" : "string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key" : "string"
                                    }
                                ]
                            }
                        },
                        "key" : "string"
                    }
                ]
            },
            "msg_type" : "INFO",
            "unit_type" : "MANAGER"
        }
    ],
    "id" : "obj-103",
    "display_name" : "string",
    "display_status" : "NOT_STARTED"
}

Attributes:

Name Type Description
Required
-.id string Unique identifier of the given 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.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.
-.display_name string Name of the cluster as displayed in vSphere client. 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.
-.current_version string Current NSX version. 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.
-.display_status string The status of the cluster displayed to user, this is based on upgrade status and precheck 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.

Defines the upgrade or precheck status of a NSX enabled vCenter cluster. 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: The upgrade or precheck is not yet planned. 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.
PRECHECK_IN_PROGRESS: The precheck 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.
PRECHECK_COMPLETED_SUCCESS: The precheck is completed with success. 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.
PRECHECK_COMPLETED_WARNING: The precheck is completed with warning. 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.
PRECHECK_COMPLETED_ERROR: The precehck is completed with error. 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.
UPGRADE_IN_QUEUE: The upgrade is planned but not yet 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.
UPGRADE_IN_PROGRESS: The upgrade 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.
UPGRADE_PAUSED: The upgrade is paused. 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.
UPGRADE_COMPLETED_SUCCESS: The upgrade is completed successfully. 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.
UPGRADE_COMPLETED_FAILED: The upgrade has failed. 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[].unit_type string The unit for which the message is generated. 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 resource units allowed for 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:
MANAGER: The unit type to identify the nsx manager 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.
EDGE: The unit type to identify the nsx edge 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.
HOST: The unit type to identify the host. 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.
CLUSTER: The unit type to identify the vCenter 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.
DEPLOYMENT: The unit type to identify the nsx deployment. 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[].msg_type 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.

Defines the type 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: The message of type information. 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: The message of type warning. 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: The message of type error. 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[].msg localizable_message Localizable message string to display. 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[].msg.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[].msg.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[].msg.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.
Optional
-.progress double The progress of the operation in percentage. 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. Only set if percentage progress is available.
-.number_of_edges long The total number of edges present in 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.

Optional. Only set if data is available.
-.number_of_hosts long The total number of hosts present in 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.

Optional. Only set if data is available.
-.number_of_edges_upgraded long The total number of edges upgraded in 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.

Optional. Only set if data is available.
-.number_of_hosts_upgraded long The total number of hosts upgraded in 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.

Optional. Only set if data is available.
-.messages message[] The messages corresponding to the cluster, this field includes the upgrade as well as the precehck messages based on the current 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. Only set if messages are present for the current cluster.
-.messages[].unit_name string If the type of the unit is manager, edge, host or cluster, this field will return the display name of the unit. 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 unit_type has value [MANAGER, EDGE, HOST, CLUSTER]. This field is optional and it is only relevant when the value of unit_type is one of MANAGER, EDGE, HOST, or CLUSTER.