REST API - list

vcenter nsx management network compatibility: list

List the distributed port groups (DVPG) and the network configuration of VMKernel NICs associated with the given cluster and dv_switch. This information will be used in populating the ManagementNetworkSpec for the enable API. 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/management-network-compatibility

?cluster={obj-103}
&dv_switch={obj-103}

Query Parameters:

Name Type Description
bold = required
cluster string Identifier of a vCenter Cluster.
dv_switch string Identifier of a vSphere Distributed Switch (VDS).

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "host_vmknics"[
            {
                "incompatible_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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                ],
                "host""obj-103",
                "subnet_mask""string",
                "best_practice_violations"[
                    {
                        "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                ],
                "vmknic""string",
                "gateway""string"
            },
            {
                "incompatible_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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                ],
                "host""obj-103",
                "subnet_mask""string",
                "best_practice_violations"[
                    {
                        "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                ],
                "vmknic""string",
                "gateway""string"
            }
        ],
        "name""string",
        "dv_portgroup""obj-103"
    },
    {
        "host_vmknics"[
            {
                "incompatible_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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                ],
                "host""obj-103",
                "subnet_mask""string",
                "best_practice_violations"[
                    {
                        "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                ],
                "vmknic""string",
                "gateway""string"
            },
            {
                "incompatible_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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                ],
                "host""obj-103",
                "subnet_mask""string",
                "best_practice_violations"[
                    {
                        "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"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                ],
                "vmknic""string",
                "gateway""string"
            }
        ],
        "name""string",
        "dv_portgroup""obj-103"
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- summary[] Compatibility information about the distributed port group and its associated VMKernel NICs from the cluster identified by cluster and the vSphere distributed switch (VDS) identified by dv_switch.
-[].dv_portgroup string Identifier of the Distributed Port Group (DVPG). 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: DistributedVirtualPortgroup. When operations return a value of this structure as a result, the field will be an identifier for the resource type: DistributedVirtualPortgroup.

-[].name string Name of the Distributed Port Group (DVPG). 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.

-[].host_vmknics host_vmknic_info[] The array of configurations of VMKernel NICs attached to the distributed port group. This list will be empty when hosts from the specified cluster do not have any VMKernel NIC attached to a port on the distributed port group. 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.

-[].host_vmknics[].host string Identifier of the Host. 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: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem.

-[].host_vmknics[].vmknic string Name of the VMKernel NIC. 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.

-[].host_vmknics[].subnet_mask string Subnet mask for the VMKernel NIC on the network. 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.

-[].host_vmknics[].gateway string Gateway IP address for the VMKernel NIC on the network. 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.

-[].host_vmknics[].incompatible_reasons localizable_message[] List of reasons for incompatibility of the vcenter.nsx.management_network_compatibility.host_vmknic_info.vmknic for management network configuration. If array of reasons is not empty, then this vcenter.nsx.management_network_compatibility.host_vmknic_info.vmknic cannot be used for the management network configuration. This field is for future use. It is not supported yet. 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.

-[].host_vmknics[].incompatible_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.

-[].host_vmknics[].incompatible_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.

-[].host_vmknics[].incompatible_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.

Errors:

HTTP Status Code Type Description
404 not_found if the cluster identified by cluster or if the vSphere distributed switch identified by dv_switch could not be located.
500 error if any other error occurs while handling the request.