Get Networks
Return information about a specific vSphere Namespaces network.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}
Path Parameters
Path 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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
NamespaceManagementNetworksInfo
of type application/json
List of information about all vSphere Namespaces networks in the cluster.
{
"namespaces": [
"string"
],
"network": "string",
"network_provider": "enum",
"nsx_network": {
"egress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"ingress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"load_balancer_size": "SMALL",
"namespace_network_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"nsx_tier0_gateway": "string",
"routed_mode": false,
"subnet_prefix_length": 0
},
"vsphere_network": {
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"gateway": "string",
"ip_assignment_mode": "DHCP",
"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: NSXT_CONTAINER_PLUGIN , VSPHERE_NETWORK
array of
string
namespaces
Optional
A list of Supervisor Namespaces associated with this network. This field is optional because it was added in a newer version than its parent node. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.namespaces.Instance. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.namespaces.Instance.
nsx_network
Optional
Configuration specification for a NSXT-backed Namespaces network configuration, supported by NSXT_CONTAINER_PLUGIN network provider. This field is optional and it is only relevant when the value of Networks.Info.network-provider is NSXT_CONTAINER_PLUGIN.
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.
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.
Code Samples
PowerCLI Client SDK Example
Invoke-GetClusterNetworkNamespaceManagement -Cluster "MyCluster" -Network "MyNetwork"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.1.0
On This Page
Networks Operations
get
post
get
put
patch
delete
