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

vcenter nsx deployment upgrade: message

The message structure contains message with respect to a single entity. 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:

{
    "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" : [
            {
                "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"
}

Attributes:

Name Type Description
Required
-.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.
-.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.
-.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.
-.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.
-.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.
-.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
-.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.
-.msg.params object Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0.

Optional. Unset means that the message template requires no arguments or positional arguments are used.
-.msg.localized string Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0.

Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.