Get Networks
Released in v7.0.1.0 DescriptionReturn information about a specific vSphere Namespaces network.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}
Parameters
Parameters
string
cluster
Required
Identifier for the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource.
string
network
Required
Identifier for the vSphere Namespaces network.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network.
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
Response
Response
Response BodyResponse Body
200 OK returns
NamespaceManagementNetworksInfo
of type application/json
List of information about all vSphere Namespaces networks in the cluster.
{
"network": "string",
"network_provider": "enum",
"vsphere_network": {
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"gateway": "string",
"portgroup": "string",
"subnet_mask": "string"
}
}
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: 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
Required
The network provider that will manage the vSphere Namespaces network object.
Possible values are:
vsphere_network
Optional
Updated configuration specification for a DVPG-backed Namespaces network object, supported by VSPHERE_NETWORK network provider. This field is optional and it is only relevant when the value of Networks.Info.network-provider is VSPHERE_NETWORK.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
Networks Operations
get
get
