Vcenter REST APIs Operations Index

Vcenter REST APIs Operations Index

All available Vcenter REST APIs Operations

Authentication
Authorization
Certificate Management Vcenter
Tls
GET
Get Certificate Management Tls
Returns the rhttpproxy TLS certificate. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
PUT
Set Certificate Management Tls
Replaces the rhttpproxy TLS certificate with the specified certificate. This operation can be used in three scenarios : 1. When the CSR is created and the private key is already stored, this operation can replace the certificate. The Tls.Spec.cert (but not Tls.Spec.key and Tls.Spec.root-cert) must be provided as input. 2. When the certificate is signed by a third party certificate authority/VMCA and the root certificate of the third party certificate authority/VMCA is already one of the trusted roots in the trust store, this operation can replace the certificate and private key. The Tls.Spec.cert and Tls.Spec.key (but not Tls.Spec.root-cert) must be provided as input. 3. When the certificate is signed by a third party certificate authority and the root certificate of the third party certificate authority is not one of the trusted roots in the trust store, this operation can replace the certificate, private key and root CA certificate. The Tls.Spec.cert,Tls.Spec.key and Tls.Spec.root-cert must be provided as input. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. The above three scenarios are only supported from vsphere 7.0 onwards. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Administer.
POST
Renew Tls
Renews the TLS certificate for the given duration period. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Administer.
POST
Replace Vmca Signed Tls
Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Administer.
Compute
Confidential Computing Sgx
Consumption Domains
Zones Cluster Associations
POST
Add Zone Associations
Maps a consumption-domain zone to the specified vSphere clusters. If a cluster or a subset of specified clusters are already members of the specified zone, the result is success for those clusters. This operation supports partial success, i.e., it is possible that a subset of the specified clusters get successfully associated with the specified zone but the association fails for a subset of clusters. The returned result will contain the details about only those clusters for which the association failed. if you do not have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.
GET
Get Zone Cluster Associations
Returns identifiers of the clusters that are mapped to the specified consumption-domain zone. if you do not have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires System.Read.
POST
Remove Zone Associations
Removes the mapping between the specified consumption-domain zone and vSphere clusters. If a cluster or a subset of specified clusters are not members of the specified zone, then the result is a success for those clusters. In order to remove the mapping between a zone and a cluster, there must not be any workload running in that zone because removing the mapping between a zone and a cluster could result in undefined behavior for the entities depending on this mapping to be present. This operation supports partial success, i.e., it is possible that the mapping gets successfully removed for a subset of the clusters but fails for another subset of the clusters. The returned result will contain the details about only those clusters for which the operation failed. if you do not have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.
Content Registries
Content Registries Harbor
Projects
POST
Create Registry Harbor Projects
Creates a project in a Harbor registry using the supplied specification. In vSphere 7.0, a Harbor registry is deployed in a vSphere cluster with vSphere namespaces enabled. When a namespace is created, a project with same name as the namespace is created in the Harbor registry, so this operation should not be called. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.content.Registry referenced by the parameter registry requires System.Read.
GET
List Registry Harbor Projects
Returns basic information of all projects in a Harbor registry. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.content.Registry referenced by the parameter registry requires System.Read.
DELETE
Delete Registry Project Harbor
Deletes the specified project from Harbor registry. Repositories and images in the project will be removed upon project deletion. Storage space of deleted images in the project will be reclaimed through next scheduled Harbor registry garbage collection. In vSphere 7.0, a Harbor registry is deployed in a vSphere cluster with vSphere namespaces enabled. When a namespace is deleted, a project with same name as the namespace is deleted from the Harbor registry, so this operation should not be called. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.content.Registry referenced by the parameter registry requires System.Read. - The resource com.vmware.vcenter.content.Registry.Harbor.Project referenced by the parameter project requires System.Read.
GET
Get Registry Project Harbor
Returns detailed information about the specified Harbor project. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.content.Registry referenced by the parameter registry requires System.Read. - The resource com.vmware.vcenter.content.Registry.Harbor.Project referenced by the parameter project requires System.Read.
POST
Purge Registry Project
Remove all repositories, images and members in the project. Storage space of deleted images in the project will be reclaimed through next scheduled Harbor registry garbage collection. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.content.Registry referenced by the parameter registry requires System.Read. - The resource com.vmware.vcenter.content.Registry.Harbor.Project referenced by the parameter project requires System.Read.
Crypto Manager Hosts Kms
Crypto Manager Kms
Datastore
Deployment
Environment Browser
Guest
Customization Specs
POST
Create Guest Customization Specs
Creates a customization specification. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ModifyCustSpecs.
GET
List Guest Customization Specs
Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ReadCustSpecs.
DELETE
Delete Name Guest Customization Specs
Deletes a customization specification with the specified identifier. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ModifyCustSpecs.
GET
Get Name Guest Customization Specs
Returns the guest customization specification from vCenter with the specified identifier. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ReadCustSpecs.
PUT
Set Name Guest Customization Specs
Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.get) and editing it. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ModifyCustSpecs.
POST
Export Name Customization Specs
Returns the content of the customization specification in the specified format. Note that any passwords in the customization specification will be set to blank values during the export operation. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ReadCustSpecs.
POST
Import Guest Customization Specs
Converts a well formatted string to a CustomizationSpecs.CreateSpec. The resulting object can be passed to CustomizationSpecs.create operation. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ModifyCustSpecs.
Host Entropy
Hvc
Identity
Inventory
Iso
Lcm
Discovery Associated Products
POST
Create Lcm Discovery Associated Products
Associates a VMware product with vCenter Server manually. The product must be taken from the product catalog API. if you do not have all of the privileges described as follows: - Operation execution requires VcLifecycle.View.
GET
List Lcm Discovery Associated Products
Retrieves a list of all associated VMware product deployments with vCenter Server in the environment. The list contains both product deployments discovered automatically and deployments registered manually through the API. if you do not have all of the privileges described as follows: - Operation execution requires VcLifecycle.View.
DELETE
Delete Product Discovery Associated Products
Deletes or dissociates a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be deleted or dissociated. if you do not have all of the privileges described as follows: - Operation execution requires VcLifecycle.View.
GET
Get Product Discovery Associated Products
Returns the detailed information of a product associated with vCenter Server. if you do not have all of the privileges described as follows: - Operation execution requires VcLifecycle.View.
PATCH
Update Product Discovery Associated Products
Modifies a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be modified. if you do not have all of the privileges described as follows: - Operation execution requires VcLifecycle.View.
Namespace Management
Supervisor Services
PATCH
Update Supervisor Service
Activate a Supervisor Service. This operation will change the SupervisorServices.State of the supervisor service to in ACTIVATED state, and activate all versions of the supervisor service.
POST
Check Content Namespace Management Supervisor Services
Perform validation checks on the content of a Supervisor Service version defined in the spec. The operation returns the validation status and relevant Supervisor Service version information that are available in the content. A custom format will always return a VALID status. Only vSphere and Carvel packages can return multiple validation statuses.
POST
Create Namespace Management Supervisor Services
Create a Supervisor Service. If version specs are provided in the spec, new Supervisor Service versions will be created as part of the operation.
GET
List Namespace Management Supervisor Services
Return the information about all Supervisor Services on this vCenter.
PATCH
Update Supervisor Service
Deactivate a Supervisor Service. This operation will change the SupervisorServices.State of the supervisor service to DEACTIVATED state, and deactivate all versions of the supervisor service. Note that this operation should be called before deleting the Supervisor Service.
DELETE
Delete Supervisor Service Namespace Management
Delete a Supervisor Service. This operation only deletes the Supervisor Service from vCenter if the Supervisor Service is in DEACTIVATED state, and all versions of the Supervisor Service are removed from vCenter. Note that the SupervisorServices.deactivate operation should be called to deactivate the Supervisor Service before the Supervisor Service can be deleted.
GET
Get Supervisor Service Namespace Management
Return the information for the specified Supervisor Service.
PATCH
Update Supervisor Service Namespace Management
Update a Supervisor Service.
Support Bundle
POST
Create Cluster Namespace Management Support Bundle
Returns the location SupportBundle.Location information for downloading the Namespaces-related support bundle for the specified cluster. Retrieving a support bundle involves two steps: - Step 1: Invoke operation to provision a token and a URI. - Step 2: Make an HTTP GET request using URI and one time used token returned in step 1 to generate the support bundle and return it. There can only be one valid token per cluster at any given time. If this operation is invoked again for the same cluster identifier while a token still valid, the API will return the same SupportBundle.Location response. The HTTP GET request will: - return 401 (Not Authorized) if the download URL is recognized, but the token is invalid. - otherwise return 200 (OK), mark the token used (invalidating it for any future use), open a application/tar download stream for the client, and start the bundle process. As part of its work, the API will orchestrate support bundling on the worker nodes of a cluster. If a failure occurs during the collection of support bundle from worker node, the API will not abort the request, but will log a warning and move on to processing other worker nodes' bundles. The API will only abort its operation if the content of the stream has been corrupted. When the API has to abort its operation (and the response stream), it will not provide any indication of failures to the client. The client will need to verify validity of the resultant file based on the format specified in the response's Content-Disposition header.
Supervisor Services Cluster Supervisor Services
POST
Create Cluster Namespace Management Supervisor Services
Create a Supervisor Service on the specified vSphere Supervisor. This operation will apply the Supervisor Service version's service definition on the cluster. This operation is possible only when the Supervisor Service and Supervisor Service version are in the ACTIVATED state. 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.
GET
List Cluster Namespace Management Supervisor Services
Return the summaries about all Supervisor Services on the specified vSphere Supervisor. 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.
DELETE
Delete Cluster Supervisor Service Namespace Management
Delete a Supervisor Service on the specified vSphere Supervisor. This operation will remove the Supervisor Service with the specified identifier from the cluster, by removing the corresponding namespace and deleting the operator(s) associated with the Supervisor Service. Note that this operation doesn't deal with the application instances that are created by the associated operator(s), so existing application instances could be orphaned if users don't clean or migrate them. 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.
GET
Get Cluster Supervisor Service Namespace Management
Return information about the specific Supervisor Service on the specified vSphere Supervisor. 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.
PUT
Set Cluster Supervisor Service Namespace Management
Set a new configuration to the specified Supervisor Service on the specified vSphere Supervisor. This operation will apply the new Supervisor Service version's service definition to the existing Supervisor Service on the cluster. This operation requires that the specified Supervisor Service is already installed in the specified Supervisor. Note that this operation doesn't interfere with the application instances that are created by the associated operator(s). So users should make sure the new version is still compatible with the existing application instances. 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.
Namespaces
Instances
POST
Create Namespaces Instances
Create a namespace object on a single vSphere cluster.
GET
List Namespaces Instances
Returns the information about all namespaces in this vCenter Server. The information is tied to a single vSphere cluster.
POST
Create Namespaces Instances V2
Create a namespace object on a Supervisor.
GET
Get Namespaces Instances V2
Returns the information about all namespaces in this vCenter Server. The information is tied to a Supervisor.
DELETE
Delete Namespace Instances
Delete the namespace object in the cluster.
GET
Get Namespace Instances
Returns information about a specific namespace on a single vSphere cluster.
PUT
Set Namespace Instances
Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.
PATCH
Update Namespace Instances
Update the namespace object. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.
GET
Get Namespace Instances V2
Returns information about a specific namespace on a Supervisor.
POST
Create Namespace Instances Registervm
Register an existing virtual machine as VM Service managed VM. This API reads data stored in a VM's ExtraConfig to create a Kubernetes resource that may be used to lifecycle manage the VM. This process may also result in the creation of a Secret or ConfigMap resource for the VM's bootstrap data. Finally, a PersistentVolumeClaim resource may be created for each of the first-class disks attached to the VM. This API triggers a non-cancellable task and returns its identifier which can be queried by calling the cis Tasks get operation. The task is retained as per the default retention rules configured in vCenter. This is a non-idempotent API that creates custom resources on the Supervisor as a side effect. If the API returns an error VI admin might need to manually address them before attempting registration again.
Namespace Self Service
POST
Activate Cluster Namespace Self Service
Activate Namespace Self Service on the cluster on which vSphere Namespaces enabled. This operation empowers Dev Users/Groups as self-service namespace users to create Supervisor Namespaces through kubectl create namespace command. activate requires the availability of one or more templates in the system. 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.
POST
Activate With Template Cluster Namespace Self Service
Activate Namespace Self Service on the cluster after configuring namespace template. This is another variant of activate except configures template before activation. The template configuration includes either creating a new template or updating the existing template, depending on the template's existence. Here is supported the flow of actions using the activateWithTemplate call: 1. Activate with the new template using activateWithTemplate call. 2. Deactivate using deactivate call. 3. Active with updating the existing template using activateWithTemplate. 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.
POST
Deactivate Cluster Namespace Self Service
Deactivate Namespace Self Service on the cluster on which vSphere Namespaces enabled. This operation reverses Dev Users/Group's self-service namespace capability on the 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.
GET
Get Cluster Namespaces Namespace Self Service
Returns information about Namespace Self Service of a specific 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.
GET
List Namespaces Namespace Self Service
Returns basic information about Namespace Self Service on all clusters on which vSphere Namespaces are enabled on this vCenter.
Namespace Templates
POST
Create Cluster Namespaces Namespace Templates
Creates a namespace template on a cluster on which vSphere Namespaces are enabled in this vCenter Server. This release supports creating a single namespace template, and the call fails if there is a request to make another one. 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.
GET
List Cluster Namespaces Namespace Templates
Returns information about all the namespace templates associated with a cluster on which vSphere Namespaces are enabled in this vCenter Server. 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.
POST
Create Supervisor 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.
GET
Get Supervisor Namespace Templates
Returns information about all the namespace templates associated with a Supervisor.
GET
Get Cluster Template Namespace Templates Namespaces
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.
PATCH
Update Cluster Template Namespace Templates Namespaces
Updates a namespace template associated with cluster on which vSphere Namespaces are enabled in this vCenter Server. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is. 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.
GET
Get Supervisor Template Namespace Templates
Get the information about a namespace template on a Supervisor.
PATCH
Update Supervisor Template Namespace Templates
Updates a namespace template associated with a Supervisor. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.
Ovf
Library Item
POST
Create Ovf Library Item
Creates a library item in content library from a virtual machine or virtual appliance. This operation creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this operation, the original content is overwritten. Meta data such as name and description is not updated for the exisitng library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource VirtualMachine or VirtualApp referenced by the attribute LibraryItem.DeployableIdentity.id requires VApp.Export. - The resource com.vmware.content.Library referenced by the attribute LibraryItem.CreateTarget.library-id requires ContentLibrary.AddLibraryItem. - The resource com.vmware.content.library.Item referenced by the attribute LibraryItem.CreateTarget.library-item-id requires System.Read.
POST
Deploy Ovf Library Item Id
Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance. This operation deploys an OVF package which is stored in the library item specified by ovfLibraryItemId. It uses the deployment specification in deploymentSpec to deploy the OVF package to the location specified by target. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter ovfLibraryItemId requires System.Read. - The resource HostSystem referenced by the attribute LibraryItem.DeploymentTarget.host-id requires System.Read. - The resource Network referenced by the map value of attribute LibraryItem.ResourcePoolDeploymentSpec.network-mappings requires System.Read. - The resource StorageProfile referenced by the attribute LibraryItem.ResourcePoolDeploymentSpec.storage-profile-id requires System.Read. - The resource Datastore referenced by the attribute LibraryItem.ResourcePoolDeploymentSpec.default-datastore-id requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItem.DeploymentTarget.resource-pool-id requires VApp.Import. - The resource Folder referenced by the attribute LibraryItem.DeploymentTarget.folder-id requires VApp.Import.
POST
Filter Ovf Library Item Id
Queries an OVF package stored in content library to retrieve information to use when deploying the package. See LibraryItem.deploy. This operation retrieves information from the descriptor of the OVF package stored in the library item specified by ovfLibraryItemId. The information returned by the operation can be used to populate the deployment specification (see LibraryItem.ResourcePoolDeploymentSpec when deploying the OVF package to the deployment target specified by target. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter ovfLibraryItemId requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItem.DeploymentTarget.resource-pool-id requires System.Read. - The resource HostSystem referenced by the attribute LibraryItem.DeploymentTarget.host-id requires System.Read. - The resource Folder referenced by the attribute LibraryItem.DeploymentTarget.folder-id requires System.Read.
Services
Storage
System Config
Tagging
Tokenservice
Token Exchange
Topology
Trusted Infrastructure
Hosts Hardware Tpm Endorsement Keys
GET
Get Host Tpm Key Hardware Endorsement Keys
Get the TPM endorsement key details on a host. The information returned is derived from executing the TPM2_ReadPublic command on the endorsement key object handle. Trusted Platform Module Library Part 3: Commands, Family "2.0", Level 00 Revision 01.59, November 8, 2019, Section 12.4 TPM2_ReadPublic if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.
GET
List Host Tpm Hardware Host Endorsement Keys
Return a list of configured endorsement keys on a host. if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.
POST
Unseal Host Tpm Key
Unseal a secret that is bound to an endorsement key. Provided with duplicate key data, load the key as a child of the specified endorsement key using the TPM2_Import command and then unseal the secret data using the TPM2_Unseal command. The duplicate key must include only outer wrapping; inner wrapping is not supported. The duplicate key cannot have a complex authorization policy (e.g. including command selection, locality, etc). Only PCR policy authorization is supported at this time. Trusted Platform Module Library Part 1: Architecture, Family "2.0", Level 00 Revision 01.59, November 8, 2019, Section 23.3 Duplication Trusted Platform Module Library Part 3: Commands, Family "2.0", Level 00 Revision 01.59, November 8, 2019, Section 13.3 TPM2_Import Trusted Platform Module Library Part 3: Commands, Family "2.0", Level 00 Revision 01.59, November 8, 2019, Section 12.7 TPM2_Unseal if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Host.Tpm.Unseal.
Trust Authority Clusters Kms Providers Credential
PUT
Set Cluster Provider Credential Async
Set the key server credential.
Vcenter
VM
POST
Clone Vm
Creates a virtual machine from an existing virtual machine. if you do not have all of the privileges described as follows: - The resource Datastore referenced by the attribute VM.DiskCloneSpec.datastore requires Datastore.AllocateSpace. - The resource Datastore referenced by the attribute VM.ClonePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Folder referenced by the attribute VM.ClonePlacementSpec.folder requires VirtualMachine.Inventory.CreateFromExisting. - The resource ResourcePool referenced by the attribute VM.ClonePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource VirtualMachine referenced by the attribute VM.CloneSpec.source requires VirtualMachine.Provisioning.Clone.
POST
Clone Vm Async
Creates a virtual machine from an existing virtual machine. if you do not have all of the privileges described as follows: - The resource Datastore referenced by the attribute VM.DiskCloneSpec.datastore requires Datastore.AllocateSpace. - The resource Datastore referenced by the attribute VM.ClonePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Folder referenced by the attribute VM.ClonePlacementSpec.folder requires VirtualMachine.Inventory.CreateFromExisting. - The resource ResourcePool referenced by the attribute VM.ClonePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource VirtualMachine referenced by the attribute VM.CloneSpec.source requires VirtualMachine.Provisioning.Clone.
POST
Create Vm
Creates a virtual machine. if you do not have all of the privileges described as follows: - The resource Folder referenced by the attribute VM.InventoryPlacementSpec.folder requires VirtualMachine.Inventory.Create. - The resource ResourcePool referenced by the attribute VM.ComputePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource Datastore referenced by the attribute VM.StoragePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Network referenced by the attribute Ethernet.BackingSpec.network requires Network.Assign.
GET
List Vm
Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec.
DELETE
Delete Vm
Deletes a virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete.
GET
Get Vm
Returns information about a virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires System.Read.
POST
Instant Clone Vm
Create an instant clone of an existing virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the attribute VM.InstantCloneSpec.source requires VirtualMachine.Provisioning.Clone and VirtualMachine.Inventory.CreateFromExisting. - The resource Folder referenced by the attribute VM.InstantClonePlacementSpec.folder requires VirtualMachine.Interact.PowerOn. - The resource ResourcePool referenced by the attribute VM.InstantClonePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource Datastore referenced by the attribute VM.InstantClonePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Network referenced by the attribute Ethernet.BackingSpec.network requires Network.Assign.
POST
Register Vm
Creates a virtual machine from existing virtual machine files on storage. if you do not have all of the privileges described as follows: - The resource Datastore referenced by the attribute VM.RegisterSpec.datastore requires System.Read. - The resource Folder referenced by the attribute VM.InventoryPlacementSpec.folder requires VirtualMachine.Inventory.Register. - The resource ResourcePool referenced by the attribute VM.ComputePlacementSpec.resource-pool requires Resource.AssignVMToPool.
POST
Relocate Vm
Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate. - The resource ResourcePool referenced by the attribute VM.RelocatePlacementSpec.resource-pool requires Resource.AssignVMToPool.
POST
Relocate Vm Async
Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate. - The resource ResourcePool referenced by the attribute VM.RelocatePlacementSpec.resource-pool requires Resource.AssignVMToPool.
POST
Unregister Vm
Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage. All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Unregister.
Vcha
Vm
Identity
Guest Processes
POST
Create Vm Guest Processes
Starts a program in the guest operating system. A process started this way can have its status queried with Processes.list or Processes.get. When the process completes, its exit code and end time will be available for 5 minutes after completion. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.
POST
Delete Vm Pid Processes
Terminates a process in the guest OS. On Posix guests, the process is sent a SIGTERM signal. If that doesn't terminate the process, a SIGKILL signal is sent. A process may still be running if it's stuck. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.
POST
Get Vm Pid Processes
Returns the status of a process running in the guest operating system, including those started by Processes.create that may have recently completed. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
POST
List Vm Guest Processes
List the processes running in the guest operating system, plus those started by Processes.create that have recently completed. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
Guest Filesystem Directories
POST
Create Vm Filesystem Directories
Creates a directory in the guest operating system. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Create Temporary Vm Filesystem Directories
Creates a temporary directory. Creates a new unique temporary directory for the user to use as needed. The guest operating system may clean up the directory after a guest specific amount of time if parentPath is not set, or the user can remove the directory when no longer needed. The new directory name will be created in a guest-specific format using prefix, a guest generated string and suffix in parentPath. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Delete Vm Filesystem Directories
Deletes a directory in the guest operating system. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Move Vm Filesystem Directories
Renames a directory in the guest. Renames the directory, or copies and deletes the old contents as required by the underlying filsystem. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
Guest Filesystem Files
POST
Create Temporary Vm Filesystem Files
Creates a temporary file. Creates a new unique temporary file for the user to use as needed. The user is responsible for removing it when it is no longer needed. The new file name will be created in a guest-specific format using prefix, a guest generated string and suffix in parentPath. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Delete Vm Path Files
Deletes a file in the guest operating system if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Get Vm Path Files
Returns information about a file or directory in the guest. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
POST
List Vm Filesystem Files
Returns information about files and directories in the guest. Files are returned in operating system-specific (inode) order. If the directory is modified between queries, missing or duplicate results can occur. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
POST
Move Vm Filesystem Files
Renames a file in the guest. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Update Vm Filesystem Files
Changes the file attributes of a specified file or directory inside the guest. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
Vm Template
Library Items
POST
Create Vm Template Library Items
Creates a library item in content library from a virtual machine. This operation creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.Library referenced by the attribute LibraryItems.CreateSpec.library requires ContentLibrary.AddLibraryItem. - The resource VirtualMachine referenced by the attribute LibraryItems.CreateSpec.source-vm requires System.Read. - The resource Datastore referenced by the attribute LibraryItems.CreateSpecVmHomeStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecVmHomeStoragePolicy.policy requires System.Read. - The resource Datastore referenced by the attribute LibraryItems.CreateSpecDiskStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecDiskStoragePolicy.policy requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.CreateSpec.disk-storage-overrides requires System.Read. - The resource Folder referenced by the attribute LibraryItems.CreatePlacementSpec.folder requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItems.CreatePlacementSpec.resource-pool requires System.Read. - The resource HostSystem referenced by the attribute LibraryItems.CreatePlacementSpec.host requires System.Read. - The resource ClusterComputeResource referenced by the attribute LibraryItems.CreatePlacementSpec.cluster requires System.Read.
POST
Deploy Template Library Item Library Items
Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem. It uses the deployment specification in spec. If LibraryItems.DeploySpec.powered-on and/or LibraryItems.DeploySpec.guest-customization are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires VirtualMachine.Provisioning.DeployTemplate. - The resource Datastore referenced by the attribute LibraryItems.DeploySpecVmHomeStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecVmHomeStoragePolicy.policy requires System.Read. - The resource Datastore referenced by the attribute LibraryItems.DeploySpecDiskStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecDiskStoragePolicy.policy requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.DeploySpec.disk-storage-overrides requires System.Read. - The resource Folder referenced by the attribute LibraryItems.DeployPlacementSpec.folder requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItems.DeployPlacementSpec.resource-pool requires System.Read. - The resource HostSystem referenced by the attribute LibraryItems.DeployPlacementSpec.host requires System.Read. - The resource ClusterComputeResource referenced by the attribute LibraryItems.DeployPlacementSpec.cluster requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.nics requires System.Read. - The resource Network referenced by the attribute LibraryItems.EthernetUpdateSpec.network requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the attribute LibraryItems.HardwareCustomizationSpec.disks-to-remove requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.disks-to-update requires System.Read.
GET
Get Template Library Item Vm Template
Returns information about a virtual machine template contained in the library item specified by templateLibraryItem if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
Library Items Check Outs
POST
Check In Template Library Item Vm Check Outs
Checks in a virtual machine into the library item. This operation updates the library item to contain the virtual machine being checked in as a template. This template becomes the latest version of the library item. The previous virtual machine template contained in the library item is available as a backup and its information can be queried using the Versions service. At most one previous version of a virtual machine template is retained in the library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckInTemplate. - The resource VirtualMachine referenced by the parameter vm requires System.Read.
POST
Check Out Template Library Item Check Outs
Checks out a library item containing a virtual machine template. This operation makes a copy of the source virtual machine template contained in the library item as a virtual machine. The virtual machine is copied with the same storage specification as the source virtual machine template. Changes to the checked out virtual machine do not affect the virtual machine template contained in the library item. To save these changes back into the library item, CheckOuts.check-in the virtual machine. To discard the changes, CheckOuts.delete the virtual machine. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckOutTemplate. - The resource Folder referenced by the attribute CheckOuts.PlacementSpec.folder requires System.Read. - The resource ResourcePool referenced by the attribute CheckOuts.PlacementSpec.resource-pool requires System.Read. - The resource HostSystem referenced by the attribute CheckOuts.PlacementSpec.host requires System.Read. - The resource ClusterComputeResource referenced by the attribute CheckOuts.PlacementSpec.cluster requires System.Read.
DELETE
Delete Template Library Item Vm Vm Template Check Outs
Deletes the checked out virtual machine. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
GET
Get Template Library Item Vm Vm Template Check Outs
Returns the information about a checked out virtual machine. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read. - The resource VirtualMachine referenced by the parameter vm requires System.Read.
GET
List Template Library Item Vm Template Check Outs
Returns commonly used information about the virtual machines that are checked out of the library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
Library Items Versions
DELETE
Delete Template Library Item Version Vm Template
Deletes the virtual machine template contained in the library item at the specified version. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.DeleteLibraryItem. - The resource com.vmware.content.library.item.Version referenced by the parameter version requires System.Read.
GET
Get Template Library Item Version Vm Template
Returns information about the live version of a library item containing a virtual machine template. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read. - The resource com.vmware.content.library.item.Version referenced by the parameter version requires System.Read.
GET
List Template Library Item Vm Template Versions
Returns commonly used information about the live versions of a virtual machine template library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
POST
Rollback Template Library Item Version
Rollbacks a library item containing a virtual machine template to a previous version. The virtual machine template at the specified version becomes the latest virtual machine template with a new version identifier. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckInTemplate. - The resource com.vmware.content.library.item.Version referenced by the parameter version requires System.Read.