This API has a deprecated equivalent from v7.0U1.

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

GET

https://{api_host}/api/vcenter/inventory/network

Copy

Query Parameters

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.

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"

Authentication

This operation uses the following authentication methods.

api_key

Response

Response Body

200 OK returns map of InventoryNetworkInfo 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.

{
	"type": "string"
}

string

type Required

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

Error

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

Error

default

‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.

Code Samples

PowerCLI Client SDK Example

Invoke-GetInventoryNetwork -Networks "MyNetworks"

cURL Command

curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/inventory/network?networks=string

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/vcenter/inventory/network?~action=find
x-vmw-doc-operation: find

Availability

Added in 7.0U2