Vcenter NamespaceManagement Networks update

Update the configuration of the vSphere Namespaces network object associated with the given cluster.

This operation was added in vSphere API 7.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Namespaces.Manage.

Request

URI

PATCH

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

COPY

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.

Request Body

Information about the network object to be updated.

Vcenter NamespaceManagement Networks UpdateSpec of type(s) application/json

Required

Show optional properties

{
    "network_provider": "string"
}

{
    "network_provider": "string",
    "vsphere_network": {
        "portgroup": "string",
        "address_ranges": [
            {
                "address": "string",
                "count": 0
            }
        ],
        "gateway": "string",
        "subnet_mask": "string",
        "mode": "string"
    },
    "nsx_network": {
        "namespace_network_cidrs": [
            {
                "address": "string",
                "prefix": 0
            }
        ],
        "ingress_cidrs": [
            {
                "address": "string",
                "prefix": 0
            }
        ],
        "egress_cidrs": [
            {
                "address": "string",
                "prefix": 0
            }
        ]
    }
}

string

network_provider

Required

The network provider that will manage the vSphere Namespaces network object.

For more information see: Vcenter NamespaceManagement Clusters NetworkProvider.

This property was added in vSphere API 7.0.3.0.

vsphere_network

Optional

Updated configuration specification for a DVPG-backed Namespaces network object, supported by Vcenter NamespaceManagement Clusters NetworkProvider.VSPHERE_NETWORK network provider.

This property was added in vSphere API 7.0.3.0.

This property is optional and it is only relevant when the value of network_provider is Vcenter NamespaceManagement Clusters NetworkProvider.VSPHERE_NETWORK.

nsx_network

Optional

Updated configuration specification for a NSXT-backed Namespaces network configuration, supported by Vcenter NamespaceManagement Clusters NetworkProvider.NSXT_CONTAINER_PLUGIN network provider.

This property was added in vSphere API 7.0.2.0.

This property is optional and it is only relevant when the value of network_provider is Vcenter NamespaceManagement Clusters NetworkProvider.NSXT_CONTAINER_PLUGIN.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

204

Success!

Operation doesn't return any data structure

400

Vapi Std Errors InvalidArgument if spec contains any errors.

Vapi Std Errors NotAllowedInCurrentState if the associated cluster is being disabled.

Vapi Std Errors ResourceInUse if the network is in use and the spec contains field values that are un-updatable in such a case.

Returns Vapi Std Errors Error of type(s) application/json

"Vapi Std Errors Error Object"

array of object

messages

Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string

error_type

Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0

"Vapi Std Errors Unauthenticated Object"

string

challenge

Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

403

if the user does not have Namespaces.Manage privilege.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthorized0

"Vapi Std Errors Unauthorized Object"

404

if cluster or the network cannot be located.

Returns Vapi Std Errors NotFound of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotFound0

"Vapi Std Errors NotFound Object"

500

if the system reports an error while responding to the request.

Returns Vapi Std Errors Error of type(s) application/json

"Vapi Std Errors Error Object"

array of object

messages

Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Some operations will not set this property when reporting errors.

string

error_type

Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.

Code Samples

COPY

                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"network_provider:"string"}'

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Vcenter Namespace Management Operations

GET

Vcenter NamespaceManagement Networks list

POST

Vcenter NamespaceManagement Networks create

GET

Vcenter NamespaceManagement Networks get

PUT

Vcenter NamespaceManagement Networks set

DELETE

Vcenter NamespaceManagement Networks delete

PATCH

Vcenter NamespaceManagement Networks update