This API has a deprecated equivalent from v7.0U1.
List Network
Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec.
Request
URLURL
https://{api_host}/api/vcenter/network
Query Parameters
Query Parameters
array of
string
datacenters
Optional
Datacenters that must contain the network for the network to match the filter. If unset or empty, networks in any datacenter match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Datacenter. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Datacenter.
array of
string
folders
Optional
Folders that must contain the network for the network to match the filter. If unset or empty, networks in any folder match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Folder. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Folder.
array of
string
names
Optional
Names that networks must have to match the filter (see Network.Summary.name). If unset or empty, networks with any name match the filter.
array of
string
networks
Optional
Identifiers of networks that can match the filter. If unset or empty, networks with any identifier match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Network. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Network.
array of
NetworkType
types
Optional
Types that networks must have to match the filter (see Network.Summary.type). If unset, networks with any type match the filter.
Header Parameters
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.
Response
Response
Response BodyResponse Body
200 OK returns
array of
NetworkSummary
of type application/json
Commonly used information about the networks matching the Network.FilterSpec.
[
{
"name": "string",
"network": "string",
"type": "STANDARD_PORTGROUP"
}
]
string
name
Required
Name of the network.
string
network
Required
Identifier of the network. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Network. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Network.
type
Required
The Network.Type enumerated type defines the type of a vCenter Server network. The type of a network can be used to determine what features it supports and which APIs can be used to find more information about the network or change its configuration.
STANDARD_PORTGROUP : vSphere standard portgroup (created and managed on ESX)
DISTRIBUTED_PORTGROUP : Distributed virtual portgroup (created and managed through vCenter)
OPAQUE_NETWORK : A network whose configuration is managed outside of vSphere. The identifer and name of the network is made available through vSphere so that host and virtual machine virtual ethernet devices can connect to them.
Possible values are: STANDARD_PORTGROUP , DISTRIBUTED_PORTGROUP , OPAQUE_NETWORK
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the Network.FilterSpec.types field contains a value that is not supported by the server.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.unable_to_allocate_resource : if more than 1000 networks match the Network.FilterSpec.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
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-ListNetwork -Networks "MyNetworks" -Names "MyNames" -Types "STANDARD_PORTGROUP" -Folders "MyFolders" -Datacenters "MyDatacenters"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/network
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/network
x-vmw-doc-operation: list
Availability
Added in 7.0U2
