Find Network
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Returns network information for the specified vCenter Server networks. The key in the result map is the network identifier and the value in the map is the network information. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource Network referenced by the parameter networks requires System.Read.
Request
URLURL
https://{api_host}/rest/com/vmware/vcenter/inventory/network?~action=find
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains InventoryNetworkFindRequestBody
of type application/json
(required)
{
"networks": [
"string"
]
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | networks | array of string |
Identifiers of the vCenter Server networks for which information will be returned. The parameter must contain identifiers for the resource type: Network. |
Response
Response
Response BodyResponse Body
200 OK returns
InventoryNetworkFindResponseBody
of type application/json
Network information for the specified vCenter Server networks. The key in the result map is the network identifier and the value in the map is the network information. The key in the result map will be an identifier for the resource type: Network.
{
"value": [
"string"
]
}| Property Name | Type | Description |
|---|---|---|
| value | array of string |
Network information for the specified vCenter Server networks. The key in the result map is the network identifier and the value in the map is the network information. The key in the result map will be an identifier for the resource type: Network. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"networks":["string"]}' https://{api_host}/rest/com/vmware/vcenter/inventory/network?~action=find
Errors
| Code | Returns | Description |
|---|---|---|
| default | ErrorRest | Not available |
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if no datastore can be found for one or more of the vCenter Server network identifiers in networks |
