Update Networks
Update the configuration of the vSphere Namespaces network object associated with the given cluster.
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"
Request Body
Request Body
NamespaceManagementNetworksUpdateSpec of mimetype application/json
Required
Information about the network object to be updated.
{
"network_provider": "enum"
}
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
Updated 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.UpdateSpec.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.UpdateSpec.network-provider is VSPHERE_NETWORK.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
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.resource_in_use : if the network is in use and the spec contains field values that are un-updatable in such a case.
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
$NamespaceManagementNetworksUpdateSpec = Initialize-NamespaceManagementNetworksUpdateSpec -NetworkProvider "NSXT_CONTAINER_PLUGIN"
Invoke-UpdateClusterNetworkNamespaceManagement -Cluster "MyCluster" -Network "MyNetwork" -NamespaceManagementNetworksUpdateSpec $NamespaceManagementNetworksUpdateSpec
PowerCLI Client SDK All Parameters Example
$NamespaceManagementIPRange = Initialize-NamespaceManagementIPRange -Address "MyAddress" -Count 0
$NamespaceManagementNetworksVsphereDVPGNetworkUpdateSpec = Initialize-NamespaceManagementNetworksVsphereDVPGNetworkUpdateSpec -Portgroup "MyPortgroup" -AddressRanges $NamespaceManagementIPRange -Gateway "MyGateway" -SubnetMask "MySubnetMask"
$NamespaceManagementIpv4Cidr = Initialize-NamespaceManagementIpv4Cidr -Address "MyAddress" -Prefix 0
$NamespaceManagementNetworksNsxNetworkUpdateSpec = Initialize-NamespaceManagementNetworksNsxNetworkUpdateSpec -NamespaceNetworkCidrs $NamespaceManagementIpv4Cidr -IngressCidrs $NamespaceManagementIpv4Cidr -EgressCidrs $NamespaceManagementIpv4Cidr
$NamespaceManagementNetworksUpdateSpec = Initialize-NamespaceManagementNetworksUpdateSpec -NetworkProvider "NSXT_CONTAINER_PLUGIN" -VsphereNetwork $NamespaceManagementNetworksVsphereDVPGNetworkUpdateSpec -NsxNetwork $NamespaceManagementNetworksNsxNetworkUpdateSpec
Invoke-UpdateClusterNetworkNamespaceManagement -Cluster "MyCluster" -Network "MyNetwork" -NamespaceManagementNetworksUpdateSpec $NamespaceManagementNetworksUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"network_provider":"enum","nsx_network":{"egress_cidrs":[{"address":"string","prefix":0}],"ingress_cidrs":[{"address":"string","prefix":0}],"namespace_network_cidrs":[{"address":"string","prefix":0}]},"vsphere_network":{"address_ranges":[{"address":"string","count":0}],"gateway":"string","portgroup":"string","subnet_mask":"string"}}' 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: update
Availability
Added in 7.0.3.0
On This Page
Networks Operations
get
post
get
put
patch
delete
