REST API - get
  1. Operations
  2. vcenter
  3. namespace management
  4. networks

vcenter namespace management networks: get

Return information about a specific vSphere Namespaces network. This operation was added in vSphere API 7.0.1.0.

Request:

HTTP request

GET https://{server}/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}

Path Parameters

Name Type Description
Required
cluster string Identifier for the cluster.
network string Identifier for the vSphere Namespaces network.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "vsphere_network" : {
        "portgroup" : "obj-103",
        "address_ranges" : [
            {
                "address" : "string",
                "count" : 1
            },
            {
                "address" : "string",
                "count" : 1
            }
        ],
        "subnet_mask" : "string",
        "gateway" : "string"
    },
    "network_provider" : "NSXT_CONTAINER_PLUGIN",
    "network" : "obj-103"
}

Headers:

None

Type:

Name Type Description
bold = required
- info List of information about all vSphere Namespaces networks in the cluster.
-.network string Identifier of the network. This attribute was added in vSphere API 7.0.1.0.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network.
-.network_provider string The network provider that will manage the vSphere Namespaces network object. This attribute was added in vSphere API 7.0.1.0.

Identifies the network plugin that cluster networking functionalities for this vSphere Namespaces Cluster. Value is one of:
NSXT_CONTAINER_PLUGIN: NSX-T Container Plugin.
VSPHERE_NETWORK: vSphere Networking. This constant was added in vSphere API 7.0.1.0.
-.vsphere_network vsphere_DVPG_network_info Updated configuration specification for a DVPG-backed Namespaces network object, supported by VSPHERE_NETWORK network provider. This attribute was added in vSphere API 7.0.1.0.

Optional. It is only relevant when network_provider has value VSPHERE_NETWORK. This field is optional and it is only relevant when the value of network_provider is VSPHERE_NETWORK.
-.vsphere_network.portgroup string Identifier of the vSphere Distributed Portgroup backing the vSphere network object. This attribute was added in vSphere API 7.0.1.0.

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.
-.vsphere_network.address_ranges IP_range[] Usable IP pools on this network. This attribute was added in vSphere API 7.0.1.0.
-.vsphere_network.address_ranges[].address string The starting address of the range. This attribute was added in vSphere API 7.0.1.0.
-.vsphere_network.address_ranges[].count long The number of IP addresses in the range. This attribute was added in vSphere API 7.0.1.0.
-.vsphere_network.gateway string Gateway for the network. This attribute was added in vSphere API 7.0.1.0.
-.vsphere_network.subnet_mask string Subnet mask of the network. This attribute was added in vSphere API 7.0.1.0.

Errors:

HTTP Status Code Type Description
404 not_found if cluster or network could not be located.
500 error if the system reports an error while responding to the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user does not have System.Read privilege.