REST API - summary

vcenter namespace management distributed switch compatibility: summary

The summary structure contains information about the compatibility of a vSphere Distributed Switch with the Namespaces feature.

Representation:

JSON
LEGACY JSON

{
    "compatible" : true,
    "incompatibility_reasons" : [
        {
            "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" : {}
                                }
                            }
                        }
                    }
                }
            }
        }
    ],
    "distributed_switch" : "obj-103",
    "network_provider" : "NSXT_CONTAINER_PLUGIN",
    "compatible_networks" : [
        "obj-103",
        "obj-103"
    ]
}

{
    "compatible" : true,
    "incompatibility_reasons" : [
        {
            "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"
                }
            ]
        },
        {
            "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"
                }
            ]
        }
    ],
    "distributed_switch" : "obj-103",
    "network_provider" : "NSXT_CONTAINER_PLUGIN",
    "compatible_networks" : [
        "obj-103",
        "obj-103"
    ]
}

Attributes:

Name	Type	Description
Required
-.distributed_switch	string	Identifier of the switch. If `networkProvider` is either unset or is set to NSXT_CONTAINER_PLUGIN, the value of this field will refer to the UUID of a vim.DistributedVirtualSwitch. Otherwise, the value of the field will refer to the ID of a vim.DistributedVirtualSwitch. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `vSphereDistributedSwitch`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `vSphereDistributedSwitch`.
-.compatible	boolean	Compatibility of this switch with vSphere Namespaces.
-.incompatibility_reasons[].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.
-.incompatibility_reasons[].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.
-.incompatibility_reasons[].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
-.incompatibility_reasons	localizable_message[]	List of reasons for incompatibility. Optional. If unset, this Distributed Switch is compatible.
-.network_provider	string	The network provider whose networks were considered. 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, clients clients should assume the value to be NSXT_CONTAINER_PLUGIN.
-.compatible_networks	string[]	List of compatible (PortGroup) Networks under the distributed switch. 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. This field is optional because it was added in a newer version than its parent node.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `Network`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `Network`.

Attributes:

Name	Type	Description
Required
distributed_switch	string	Identifier of the switch. If `networkProvider` is either unset or is set to NSXT_CONTAINER_PLUGIN, the value of this field will refer to the UUID of a vim.DistributedVirtualSwitch. Otherwise, the value of the field will refer to the ID of a vim.DistributedVirtualSwitch. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `vSphereDistributedSwitch`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `vSphereDistributedSwitch`.
compatible	boolean	Compatibility of this switch with vSphere Namespaces.
incompatibility_reasons[].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.
incompatibility_reasons[].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.
incompatibility_reasons[].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
incompatibility_reasons	localizable_message[]	List of reasons for incompatibility. Optional. If unset, this Distributed Switch is compatible.
network_provider	string	The network provider whose networks were considered. 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, clients clients should assume the value to be NSXT_CONTAINER_PLUGIN.
compatible_networks	string[]	List of compatible (PortGroup) Networks under the distributed switch. 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. This field is optional because it was added in a newer version than its parent node.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `Network`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `Network`.