Create Networks
Create a vSphere Namespaces network object associated with the given cluster.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/networks
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
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"
Request Body
Request Body
NamespaceManagementNetworksCreateSpec of mimetype application/json
Required
Information about the network object to be created.
{
"network": "string",
"network_provider": "enum"
}
string
network
Required
Identifier of the network. This has DNS_LABEL restrictions as specified in . This must be an alphanumeric (a-z and 0-9) string and with maximum length of 63 characters and with the ‘-’ character allowed anywhere except the first or last character. This name must be unique within a cluster. 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
nsx_network
Optional
The create spec 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.CreateSpec.network-provider is NSXT_CONTAINER_PLUGIN.
vsphere_network
Optional
The create spec 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.CreateSpec.network-provider is VSPHERE_NETWORK.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.already_exists : if a network by the name as specified in the Networks.CreateSpec already exists. | com.vmware.vapi.std.errors.invalid_argument : if spec contains any errors. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the associated cluster is being disabled. | com.vmware.vapi.std.errors.unsupported : if spec contains NsxNetworkCreateSpec which is unsupported via create API.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Manage 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
$NamespaceManagementNetworksCreateSpec = Initialize-NamespaceManagementNetworksCreateSpec -Network "MyNetwork" -NetworkProvider "NSXT_CONTAINER_PLUGIN"
Invoke-CreateClusterNamespaceManagementNetworks -Cluster "MyCluster" -NamespaceManagementNetworksCreateSpec $NamespaceManagementNetworksCreateSpec
PowerCLI Client SDK All Parameters Example
$NamespaceManagementIPRange = Initialize-NamespaceManagementIPRange -Address "MyAddress" -Count 0
$NamespaceManagementNetworksVsphereDVPGNetworkCreateSpec = Initialize-NamespaceManagementNetworksVsphereDVPGNetworkCreateSpec -Portgroup "MyPortgroup" -IpAssignmentMode "DHCP" -AddressRanges $NamespaceManagementIPRange -Gateway "MyGateway" -SubnetMask "MySubnetMask"
$NamespaceManagementIpv4Cidr = Initialize-NamespaceManagementIpv4Cidr -Address "MyAddress" -Prefix 0
$NamespaceManagementNetworksNsxNetworkCreateSpec = Initialize-NamespaceManagementNetworksNsxNetworkCreateSpec -NamespaceNetworkCidrs $NamespaceManagementIpv4Cidr -IngressCidrs $NamespaceManagementIpv4Cidr -EgressCidrs $NamespaceManagementIpv4Cidr -NsxTier0Gateway "MyNsxTier0Gateway" -SubnetPrefixLength 0 -RoutedMode $false -LoadBalancerSize "SMALL"
$NamespaceManagementNetworksCreateSpec = Initialize-NamespaceManagementNetworksCreateSpec -Network "MyNetwork" -NetworkProvider "NSXT_CONTAINER_PLUGIN" -VsphereNetwork $NamespaceManagementNetworksVsphereDVPGNetworkCreateSpec -NsxNetwork $NamespaceManagementNetworksNsxNetworkCreateSpec
Invoke-CreateClusterNamespaceManagementNetworks -Cluster "MyCluster" -NamespaceManagementNetworksCreateSpec $NamespaceManagementNetworksCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"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"}}' https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/networks
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create
Availability
Added in 7.0.3.0
On This Page
Networks Operations
get
post
get
put
patch
delete
