Create V2 Namespace Templates
Creates a namespace template on a Supervisor. This release supports creating a single namespace template, and the call fails if there is a request to make another one.
Request
URLURL
https://{api_host}/api/vcenter/namespaces/namespace-templates/supervisors/{supervisor}
Path Parameters
Path Parameters
string
supervisor
Required
Identifier for the Supervisor. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.
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
NamespacesNamespaceTemplatesCreateSpec of mimetype application/json
Required
Specification for setting up the namespace template.
{
"resource_spec": {},
"storage_specs": [
{
"policy": "string"
}
],
"template": "string"
}
object
resource_spec
Required
Resource quotas that this template defines. Resource quota on the namespace. 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.
array of
NamespacesInstancesStorageSpec
storage_specs
Required
Storage that this template defines and will be associated with a namespace after namespace realization. This field should not be empty and at least one policy should be supplied. The {link create} throws {term InvalidArgument} exception if this field is set empty.
string
template
Required
Identifier of the namespace template. This has DNS_LABEL restrictions as specified in . This name is unique across all namespaces templates in this vCenter server. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.
array of
string
networks
Optional
vSphere Networks that this template captures and are associated with the namespace after namespace realization. vSphere Namespaces network objects to be associated with the namespace. The values of this list need to reference names of pre-existing com.vmware.vcenter.namespace_management.Networks.Info structures. The field must be left unset if the cluster hosting the namespace uses NSXT_CONTAINER_PLUGIN as the network provider, since the network(s) for this namespace will be managed by NSX-T Container Plugin. If field is unset when the cluster hosting the namespace uses VSPHERE_NETWORK as its network provider, the namespace will automatically be associated with the cluster’s Supervisor Primary Workload Network. The field currently accepts at most only 1 vSphere Namespaces network object reference. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.namespace_management.Network. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.namespace_management.Network.
array of
NamespacesNamespaceTemplatesSubject
permissions
Optional
Permissions associated with namespace template. If unset, only users with the Administrator role can use this template; for example, this template is applied to the namespace created by self-service-users with the Administrator role.
vm_service_spec
Optional
VM Service specification to be associated with the namespace template. Namespaces created using this template will have access to the virtual machine classes and Content Libraries specified in the NamespaceTemplates.CreateSpec.vm-service-spec by default. If unset, the namespaces created using this template will not have access to any virtual machine classes and Content Libraries by default.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if spec contain any errors, or if {link CreateSpec#storageSpecs} is empty, or if {link CreateSpec#resourceSpec} is not set with {term memory_limit}, {term cpu_limit}, {term storage_request_limit}, or if {link CreateSpec#networks} is not set with networks if the Supervisor hosting the namespaces uses VSPHERE_NETWORK as its network provider, or if {link CreateSpec#networks} is not empty if the Supervisor hosting the namespaces uses NSXT_CONTAINER_PLUGIN as its network provider. | com.vmware.vapi.std.errors.unsupported : if a request arrives to create a second template. | com.vmware.vapi.std.errors.already_exists : if the namespace template with given name already exists.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.SelfServiceManage 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
$NamespacesInstancesStorageSpec = Initialize-NamespacesInstancesStorageSpec -Policy "MyPolicy"
$NamespacesNamespaceTemplatesCreateSpec = Initialize-NamespacesNamespaceTemplatesCreateSpec -Template "MyTemplate" -ResourceSpec -StorageSpecs $NamespacesInstancesStorageSpec
Invoke-CreateSupervisorNamespaceTemplates -Supervisor "MySupervisor" -NamespacesNamespaceTemplatesCreateSpec $NamespacesNamespaceTemplatesCreateSpec
PowerCLI Client SDK All Parameters Example
$NamespacesInstancesStorageSpec = Initialize-NamespacesInstancesStorageSpec -Policy "MyPolicy" -Limit 0
$NamespacesNamespaceTemplatesSubject = Initialize-NamespacesNamespaceTemplatesSubject -SubjectType "USER" -Subject "MySubject" -Domain "MyDomain"
$NamespacesInstancesVMServiceSpec = Initialize-NamespacesInstancesVMServiceSpec -ContentLibraries "MyContentLibraries" -VmClasses "MyVmClasses"
$NamespacesNamespaceTemplatesCreateSpec = Initialize-NamespacesNamespaceTemplatesCreateSpec -Template "MyTemplate" -ResourceSpec -StorageSpecs $NamespacesInstancesStorageSpec -Networks "MyNetworks" -Permissions $NamespacesNamespaceTemplatesSubject -VmServiceSpec $NamespacesInstancesVMServiceSpec
Invoke-CreateSupervisorNamespaceTemplates -Supervisor "MySupervisor" -NamespacesNamespaceTemplatesCreateSpec $NamespacesNamespaceTemplatesCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"networks":["string"],"permissions":[{"domain":"string","subject":"string","subject_type":"enum"}],"resource_spec":{},"storage_specs":[{"limit":0,"policy":"string"}],"template":"string","vm_service_spec":{"content_libraries":["string"],"vm_classes":["string"]}}' https://{api_host}/api/vcenter/namespaces/namespace-templates/supervisors/{supervisor}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create_v2
Availability
Added in 8.0.0.1
