Vcenter Namespaces NamespaceTemplates get

Vcenter Namespaces NamespaceTemplates get

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.

This operation was added in vSphere API 7.0.2.00100.

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

  • The resource com.vmware.vcenter.namespaces.NamespaceTemplate referenced by the parameter template requires System.Read.
Request
URI
GET
https://{api_host}/api/vcenter/namespaces/namespace-templates/clusters/{cluster}/{template}
COPY
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.


Authentication
This operation uses the following authentication methods.
Responses
200

Information about the namespace template.

Returns Vcenter Namespaces NamespaceTemplates Info of type(s) application/json
{
    "cluster": "string",
    "template": "string",
    "resource_spec": {},
    "storage_specs": [
        {
            "policy": "string",
            "limit": 0
        }
    ],
    "networks": [
        "string"
    ],
    "permissions": [
        {
            "subject_type": "string",
            "subject": "string",
            "domain": "string"
        }
    ],
    "vm_service_spec": {
        "content_libraries": [
            "string"
        ],
        "vm_classes": [
            "string"
        ]
    },
    "content_libraries": [
        {
            "content_library": "string",
            "writable": false,
            "allow_import": false,
            "resource_naming_strategy": "string"
        }
    ]
}
string
cluster
Required

Identifier for the vSphere cluster associated with namespace template.

This property was added in vSphere API 7.0.2.00100.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.

string
template
Required

Name of the namespace template.

This property was added in vSphere API 7.0.2.00100.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespaces.NamespaceTemplate.

object
resource_spec
Optional

Resource quotas that this template defines. Quotas on the namespace resources. Refer to GET /vcenter/namespace-management/clusters/{cluster}/workload-resource-options for the type of the value for this field.

This property was added in vSphere API 7.0.2.00100.

If missing or null, no resource constraints are defined in the namespace template.

array of object
storage_specs
Required

Storage that this template defines and will be associated with a namespace after namespace realization.

This property was added in vSphere API 7.0.2.00100.

array of string
networks
Optional

vSphere Networks that this template captures and are associated with the namespace after namespace realization.

This property was added in vSphere API 7.0.2.00100.

This field is missing or null if the cluster hosting this namespace uses NSXT_CONTAINER_PLUGIN or NSX_VPC as its network provider.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.namespace_management.Network. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.namespace_management.Network.

array of object
permissions
Optional

Permissions associated with namespace template.

This property was added in vSphere API 7.0.2.00100.

If missing or null, 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

Current set of virtual machine classes and Content Libraries associated with the template.

This property was added in vSphere API 7.0.3.2.

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

array of object
content_libraries
Optional

Current set of Content Library specifications associated with the template.

This property was added in vSphere API 8.0.2.0.

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


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 System.Read 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 doesn't exist or if template doesn't exist.

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 -H 'Authorization: <value>' https://{api_host}/api/vcenter/namespaces/namespace-templates/clusters/{cluster}/{template}