REST API - set

vcenter namespace management networks: set

Set a new configuration for the vSphere Namespaces network object associated with the given cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

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

{
    "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"
}

Path Parameters

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

Body Parameters:

Name	Type	Description
bold = required
-	set_spec	Information about the network object to be set.
-.network_provider	string	The network provider that will manage the vSphere Namespaces network object. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. 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_set_spec	Modified configuration specification for a DVPG-backed Namespaces network object, supported by `VSPHERE_NETWORK` network provider. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. 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. The field is settable only if the network object has not been associated with a Namespace. Setting this field when the network object is already associated with a Namespace will result in the operation failing with a `not_allowed_in_current_state` error. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. 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. Replacement of or modification to any existing range in this list is allowed only if the network object has not been associated with a Namespace. Once the network object is associated with a Namespace, new ranges may be be added to the list, but existing ranges have to be passed in without modifications. Attempts to perform modify or remove existing ranges from the list will result in the operation failing with a `not_allowed_in_current_state` error. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.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. The field is settable only if the network object has not been associated with a Namespace. Setting this field when the network object is already associated with a Namespace will result in the operation failing with a `not_allowed_in_current_state` error. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vsphere_network.subnet_mask	string	Subnet mask of the network. The field is settable only if the network object has not been associated with a Namespace. Setting this field when the network object is already associated with a Namespace will result in the operation failing with a `not_allowed_in_current_state` error. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Response:

HTTP Status Code: 204

Headers:

None

Type:

None

Errors:

HTTP Status Code	Type	Description
400	already_exists
500	error	if the system reports an error while responding to the request.
400	not_allowed_in_current_state	if the associated cluster is being disabled, or if the `spec` contains field values that are un-settable given the current state of the network.
404	not_found	if `cluster` or the `network` cannot be located.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user does not have Namespaces.Manage privilege.