List Network Labels

List Network Labels

API retrieves by filtering on the network type (if specified) that may be suitable for configuration with a desktop pool/farm's network interface card.
At least one of the listed privileges is required -

Privileges Description
GLOBAL_CONFIG_VIEW Caller should have permission to this privilege, to perform this operation.
VC_CONFIG_VIEW Caller should have permission to this privilege, to perform this operation.
Request
URI
GET
https://{api_host}//localhost/rest/external/v1/network-labels
COPY
Query Parameters
string
host_or_cluster_id
Required

Host or Cluster ID

string
network_type
Optional

Network Type

  • NETWORK: Standard network.
  • OPAQUE_NETWORK: Opaque network.
  • DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS Port group.
Possible values are : NETWORK, OPAQUE_NETWORK, DISTRUBUTED_VIRTUAL_PORT_GROUP,
string
vcenter_id
Required

Virtual Center ID


Authentication
This operation uses the following authentication methods.
Responses
200

OK

[
    {
        "available_ports": 0,
        "id": "network-1",
        "incompatible_reasons": [
            "string"
        ],
        "label_type": "EARLY_BINDING",
        "max_ports": 0,
        "name": "VM Network",
        "switch_type": "STANDARD_SWITCH"
    }
]

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure