Set Instances
Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.
Request
URLURL
https://{api_host}/api/vcenter/namespaces/instances/{namespace}
Path Parameters
Path Parameters
string
namespace
Required
Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.
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
NamespacesInstancesSetSpec of mimetype application/json
Required
New specification for the namespace.
{
"access_list": [
{
"domain": "string",
"identity_provider": "string",
"role": "OWNER",
"subject": "string",
"subject_type": "USER"
}
],
"description": "string",
"resource_spec": {},
"storage_specs": [
{
"limit": 0,
"policy": "string"
}
],
"vm_service_spec": {
"content_libraries": [
"string"
],
"vm_classes": [
"string"
]
}
}
array of
NamespacesInstancesAccess
access_list
Optional
Access control associated with the namespace. If unset, 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.
string
description
Optional
Description for the namespace. If unset, 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 com.vmware.vcenter.namespace_management.NamespaceResourceOptions.Info#createResourceQuotaType and use com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get for retrieving the type for the value for this field. For an example of this, see ResourceQuotaOptionsV1. If unset, the resource constraints on the namespace will be cleared.
array of
NamespacesInstancesStorageSpec
storage_specs
Optional
Storage associated with the namespace. If unset, 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 field is optional because it was added in a newer version than its parent node.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if spec contain any errors. | com.vmware.vapi.std.errors.not_allowed_in_current_state : 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. | com.vmware.vapi.std.errors.unsupported : if customizable VM classes are not suported for this Supervisor cluster.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Configure privilege or the namespace identifier begins with “vmware-system” prefix.
404
com.vmware.vapi.std.errors.not_found : if namespace with the name namespace could not be located.
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
$NamespacesInstancesAccess = Initialize-NamespacesInstancesAccess -SubjectType "USER" -Subject "MySubject" -Domain "MyDomain" -Role "OWNER" -IdentityProvider "MyIdentityProvider"
$NamespacesInstancesStorageSpec = Initialize-NamespacesInstancesStorageSpec -Policy "MyPolicy" -Limit 0
$NamespacesInstancesVMServiceSpec = Initialize-NamespacesInstancesVMServiceSpec -ContentLibraries "MyContentLibraries" -VmClasses "MyVmClasses"
$NamespacesInstancesSetSpec = Initialize-NamespacesInstancesSetSpec -Description "MyDescription" -ResourceSpec -AccessList $NamespacesInstancesAccess -StorageSpecs $NamespacesInstancesStorageSpec -VmServiceSpec $NamespacesInstancesVMServiceSpec
Invoke-SetNamespaceInstances -Namespace "MyNamespace" -NamespacesInstancesSetSpec $NamespacesInstancesSetSpec
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"access_list":[{"domain":"string","identity_provider":"string","role":"OWNER","subject":"string","subject_type":"USER"}],"description":"string","resource_spec":{},"storage_specs":[{"limit":0,"policy":"string"}],"vm_service_spec":{"content_libraries":["string"],"vm_classes":["string"]}}' https://{api_host}/api/vcenter/namespaces/instances/{namespace}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: set
Availability
Added in 7.0.0.0
On This Page
Instances Operations
get
post
get
put
patch
delete
post
get
