Vcenter Network list

Vcenter Network list

Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Vcenter Network FilterSpec.

Request
URI
GET
https://{api_host}/api/vcenter/network
COPY
Query Parameters
string of array
networks
Optional

Identifiers of networks that can match the filter.

If missing or null or empty, networks with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Network. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Network.

string of array
names
Optional

Names that networks must have to match the filter (see Vcenter Network Summary.name).

If missing or null or empty, networks with any name match the filter.

string of array
types
Optional

Types that networks must have to match the filter (see Vcenter Network Summary.type).

For more information see: Vcenter Network Type.

If missing or null, networks with any type match the filter.

string of array
folders
Optional

Folders that must contain the network for the network to match the filter.

If missing or null or empty, networks in any folder match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Folder. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Folder.

string of array
datacenters
Optional

Datacenters that must contain the network for the network to match the filter.

If missing or null or empty, networks in any datacenter match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datacenter. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datacenter.

Authentication
This operation uses the following authentication methods.
Responses
200

Commonly used information about the networks matching the Vcenter Network FilterSpec.

[
    {
        "network": "string",
        "name": "string",
        "type": "string"
    }
]
array of Vcenter Network Summary
Optional

400

if the Vcenter Network FilterSpec.types property contains a value that is not supported by the server.

Returns Vapi Std Errors InvalidArgument of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0 
"Vapi Std Errors InvalidArgument Object"

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

500

if more than 1000 networks match the Vcenter Network FilterSpec.

Returns Vapi Std Errors UnableToAllocateResource of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors UnableToAllocateResource0 
"Vapi Std Errors UnableToAllocateResource Object"

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0 
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/network
On This Page
Vcenter Operations
GET
Vcenter Network list