Get Namespace Templates
Get the information about a namespace template on given cluster. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
Request
URLURL
https://{api_host}/api/vcenter/namespaces/namespace-templates/clusters/{cluster}/{template}
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.
string
template
Required
Name of the namespace template. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate.
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
NamespacesNamespaceTemplatesInfo
of type application/json
Information about the namespace template.
{
"cluster": "string",
"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"
]
}
}
string
cluster
Required
Identifier for the vSphere cluster associated with namespace template. 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
NamespacesInstancesStorageSpec
storage_specs
Required
Storage that this template defines and will be associated with a namespace after namespace realization.
string
template
Required
Name of the namespace template. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate.
array of
string
networks
Optional
vSphere Networks that this template captures and are associated with the namespace after namespace realization. This field is unset if the cluster hosting this namespace uses NSXT_CONTAINER_PLUGIN as its network provider. 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.
object
resource_spec
Optional
Resource quotas that this template defines. Quotas on the namespace resources. Refer to com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get for the type of the value for this field. If unset, no resource constraints are defined in the namespace template.
vm_service_spec
Optional
Current set of virtual machine classes and Content Libraries associated with the template. This field is optional because it was added in a newer version than its parent node.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
404
com.vmware.vapi.std.errors.not_found : if cluster doesn’t exist or if template doesn’t exist.
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
Invoke-GetClusterTemplateNamespaceTemplatesNamespaces -Cluster "MyCluster" -Template "MyTemplate"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespaces/namespace-templates/clusters/{cluster}/{template}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.2.00100
