Vcenter Namespaces Instances set

Vcenter Namespaces Instances set

Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.

This operation was added in vSphere API 7.0.0.0.

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

  • The resource com.vmware.vcenter.namespaces.Instance referenced by the parameter namespace requires Namespaces.Configure.
Request
URI
PUT
https://{api_host}/api/vcenter/namespaces/instances/{namespace}
COPY
Path Parameters
string
namespace
Required

Identifier for the namespace.

The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.


Request Body

New specification for the namespace.

Vcenter Namespaces Instances SetSpec of type(s) application/json
Required
{
    "description": "string",
    "resource_spec": {},
    "access_list": [
        {
            "subject_type": "string",
            "subject": "string",
            "domain": "string",
            "role": "string",
            "identity_provider": "string"
        }
    ],
    "storage_specs": [
        {
            "policy": "string",
            "limit": 0
        }
    ],
    "vm_service_spec": {
        "content_libraries": [
            "string"
        ],
        "vm_classes": [
            "string"
        ]
    },
    "content_libraries": [
        {
            "content_library": "string",
            "writable": false,
            "allow_import": false,
            "resource_naming_strategy": "string"
        }
    ],
    "network_spec": {
        "network_provider": "string",
        "vpc_config": {
            "default_subnet_size": 0,
            "private_cidrs": [
                {
                    "address": "string",
                    "prefix": 0
                }
            ]
        }
    }
}
string
description
Optional

Description for the namespace.

This property was added in vSphere API 7.0.0.0.

If missing or null, the description of the namespace will be cleared.

object
resource_spec
Optional

Resource quota for the namespace. This will replace the existing resource constraints on the namespace in entirety. Refer to Vcenter NamespaceManagement NamespaceResourceOptions Info.create_resource_quota_type and use GET /vcenter/namespace-management/clusters/{cluster}/workload-resource-options for retrieving the type for the value for this field. For an example of this, see Vcenter Namespaces ResourceQuotaOptionsV1.

This property was added in vSphere API 7.0.0.0.

If missing or null, the resource constraints on the namespace will be cleared.

array of object
access_list
Optional

Access control associated with the namespace.

This property was added in vSphere API 7.0.0.0.

If missing or null, the existing access controls on the namespace will be removed and users will not be able to access this namespace to create new pods. Existing pods from users will continue to run.

array of object
storage_specs
Optional

Storage associated with the namespace.

This property was added in vSphere API 7.0.0.0.

If missing or null, the existing storage policies will be disassociated with the namespace and existing limits will be cleared. Pods which are already using persistent storage from the earlier version of storage policies will be able to access them till the datastores are attached to the worker nodes.

vm_service_spec
Optional

VM Service specification associated with the namespace.

This property was added in vSphere API 7.0.2.00100.

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

array of object
content_libraries
Optional

List of Content Libraries used by the VM Image Service. This list refers to existing Content Libraries in vSphere inventory.

The Content Libraries specified in {VMServiceSpec#contentLibraries} will also be included in this list but will be read-only by default to users.

If the same Content Library is present both here and in {VMServiceSpec#contentLibraries}, then:

  • The Content Library is only surfaced to users once.
  • The settings here are honored.

This property was added in vSphere API 8.0.2.0.

If missing or null, the existing Content Libraries configured for the VM Image Service will be removed.

network_spec
Optional

Network related configurations to be set with this namespace.

This property was added in vSphere API 9.0.0.0.

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

Authentication
This operation uses the following authentication methods.
Responses
204

Success!

Operation doesn't return any data structure

400

Vapi Std Errors InvalidArgument if spec contain any errors.

Vapi Std Errors NotAllowedInCurrentState if the namespace is marked for deletion or if the associated Supervisor cluster is being disabled or if the associated Supervisor cluster is being restored from a backup. When a Supervisor cluster is restored, there's a window of time during which the restored Supervisor cluster's state is being synchronized back to vCenter. During that time, namespace configuration modifications are not allowed.

Vapi Std Errors Unsupported if customizable VM classes are not supported for this Supervisor cluster.

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.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

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 namespace with the name namespace could not 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.

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.


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcenter/namespaces/instances/{namespace}