vcenter inventory network: find
Returns network information for the specified vCenter Server networks. The key in the result key/value pairs is the network identifier and the value in the key/value pairs is the network information.
Request:
HTTP request
POST https://{server}/rest/com/vmware/vcenter/inventory/network?~action=find
Request Body Structure:
{
"networks": [
"obj-103",
"obj-103"
]
}
"networks": [
"obj-103",
"obj-103"
]
}
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| networks | string[] | Identifiers of the vCenter Server networks for which information will be returned. |
Response:
HTTP Status Code: 200
Representation:
{
"value": [
{
"key": "obj-103",
"value": {
"type": "string"
}
}
]
}
"value": [
{
"key": "obj-103",
"value": {
"type": "string"
}
}
]
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | list | Network information for the specified vCenter Server networks. The key in the result key/value pairs is the network identifier and the value in the key/value pairs is the network information.List of {"key": string, "value": info} |
| value[].key | string | |
| value[].value | info | Optional. |
| value[].value.type | string | Type of the vCenter Server network. When clients pass a value of this structure as a parameter, the field must be one of Network, DistributedVirtualPortgroup, or OpaqueNetwork. When operations return a value of this structure as a result, the field will be one of Network, DistributedVirtualPortgroup, or OpaqueNetwork. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if no datastore can be found for one or more of the vCenter Server network identifiers in networks |