Find Network

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

URL

POST

https://{api_host}/rest/com/vmware/vcenter/inventory/network?~action=find

Header Parameters

string

vmware-api-session-id Required

Required session ID, acquired from Create Session API under CIS product

vmware-api-session-id Example

b00db39f948d13ea1e59b4d6fce56389

Request Body

InventoryNetworkFindRequestBody of type application/json (required)

{
    "networks": [
        "string"
    ]
}

array of string

networks Required

Identifiers of the vCenter Server networks for which information will be returned. The parameter must contain identifiers for the resource type: Network.

Response

Response 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"
    ]
}

array of string

value Optional

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

ErrorRest

404

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