vCenter REST APIs Operations Index

All available vCenter REST APIs Operations.

Authentication

Token

post

Issue Token
Provides a token endpoint as defined in RFC 6749. Supported grant types: - urn:ietf:params:oauth:grant-type:token-exchange - Exchanges incoming token based on the spec and current client authorization data. This operation supercedes com.vmware.vcenter.tokenservice.TokenExchange#exchange. The REST rendering of the newer operation matches RFC8693's definition for both input and output of the operation.

Authorization

Privilege Checks

post	List Privilege Checks Queries the privilege checks matching given criteria. if you do not have all of the privileges described as follows: - Operation execution requires Sessions.CollectPrivilegeChecks.

Privilege Checks Latest

get	Get Privilege Checks Latest Returns a marker to the last recorded privilege check. if you do not have all of the privileges described as follows: - Operation execution requires Sessions.CollectPrivilegeChecks.

Certificate Management

vCenter Signing Certificate

get	Get vCenter Signing Certificate Retrieve the signing certificate chains for validating vCenter-issued tokens. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
put	Set vCenter Signing Certificate Set the active signing certificate for vCenter. The certificate will immediately be used to sign tokens issued by vCenter token service. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Administer.
post	Refresh vCenter Signing Certificate Refresh the vCenter signing certificate chain. The new signing certificate will be issued in accordance with vCenter CA policy and set as the active signing certificate for the vCenter token service. The certificate will immediately be used to sign tokens issued by vCenter token service. If a third-party/custom certificate has been configured as the signing certificate for compliance reasons, refresh may take vCenter out of compliance. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Administer.

vCenter TLS

get	Get vCenter 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 vCenter 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 vCenter 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 vCenter 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.

vCenter TLS CSR

post	Create vCenter TLS CSR Generates a CSR with the given Spec. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Manage and CertificateManagement.Administer.

vCenter Trusted Root Chains

get	List vCenter Trusted Root Chains Returns summary information for each trusted root certificate chain. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
post	Create vCenter Trusted Root Chains Creates a new trusted root certificate chain from the CreateSpec. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Manage and CertificateManagement.Administer.
get	Get vCenter Trusted Root Chains Retrieve a trusted root certificate chain for a given identifier. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
delete	Delete vCenter Trusted Root Chains Deletes trusted root certificate chain for a given identifier. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Manage and CertificateManagement.Administer.

vCenter VMCA Root

post

Create vCenter VMCA Root
Replace Root Certificate with VMCA signed one using the given Spec. 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

Policies

get	List Policies Returns information about the compute policies available in this vCenter server. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
post	Create Policies Creates a new compute policy. if you do not have all of the privileges described as follows: - Operation execution requires ComputePolicy.Manage.
get	Get Policies Returns information about a specific compute policy. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
delete	Delete Policies Deletes a specific compute policy. if you do not have all of the privileges described as follows: - Operation execution requires ComputePolicy.Manage.

Policies Capabilities

get	List Policies Capabilities Returns information about the compute policy capabilities available in this vCenter server. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
get	Get Policies Capabilities Returns information about a specific compute policy capability. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.

Policies Tag Usage

get	List Policies Tag Usage Returns information about the tags used by policies available in this vCenter server matching the TagUsage.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.

Confidential Computing

Sgx Hosts

post	Register Sgx Hosts Task Register host by stored SGX configuration.

Consumption Domains

Zones

get	List Zones Returns information about the zones available on this vCenter server, where the zones need to match Zones.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
post	Create Zones Creates a zone based on the provided specifications. if you do not have all of the privileges described as follows: - Operation execution requires Zone.Manage.
get	Get Zones Returns the information about a specific zone. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
delete	Delete Zones Deletes the zone with the specified identifier. In order to delete a zone, there must not be any workload running in that zone because deleting the zone without removing all the dependencies on that zone can cause undefined behavior for the entities depending on this zone to be present. if you do not have all of the privileges described as follows: - Operation execution requires Zone.Manage.

Zone Associations Cluster

get	List Zone Associations Cluster Returns zone-cluster associations that match the specified filter. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.

Zones Cluster Associations

get	Get Zones 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	Add Zones Cluster 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.
post	Remove Zones Cluster 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 Harbor

get	List Registries Harbor Returns basic information of all Harbor registries.
post	Create Registries Harbor Creates a Harbor registry in the cluster.
get	Get Registries Harbor Get detailed information of the Harbor registry.
delete	Delete Registries Harbor Delete the Harbor registry in the cluster. All Harbor projects, repositories and images will be deleted upon Harbor registry deletion.

Registries Health

get	Get Registries Health Returns the health information of a container registry in the vCenter.

Registries Harbor Projects

post	Create Registries 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.
get	List Registries Harbor Projects Returns basic information of all projects in a Harbor registry.
get	Get Registries Harbor Projects Returns detailed information about the specified Harbor project.
delete	Delete Registries Harbor Projects 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.
post	Purge Registries Harbor Projects 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.

Crypto Manager

Hosts KMS Providers

get	List Hosts KMS Providers List the available providers on a host. if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.
get	Get Hosts KMS Providers Get a provider on a host. if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.

KMS Providers

get	List KMS Providers Return a list of providers. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ReadKeyServersInfo.
post	Create KMS Providers Add a new provider. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ManageKeyServers.
get	Get KMS Providers Return information about a provider. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ReadKeyServersInfo.
patch	Update KMS Providers Update an existing provider. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ManageKeyServers.
delete	Delete KMS Providers Remove a provider. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ManageKeyServers.
post	Export KMS Providers Export provider configuration. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ManageKeyServers.
post	Import Provider KMS Providers Import provider configuration. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ManageKeyServers.

Datastore

Default Policy

get	Get Default Policy Returns the identifier of the current default storage policy associated with the specified datastore.

Deployment

Import History

get	Get Import History Get the current status of the vCenter historical data import.
post	Cancel Import History Cancels the task for importing vCenter historical data.
post	Pause Import History Pauses the task for importing vCenter historical data.
post	Resume Import History Resumes the task for importing vCenter historical data.
post	Start Import History Creates and starts task for importing vCenter historical data.

Install

get	Get Install Get the parameters used to configure the ongoing appliance installation.
post	Cancel Install Cancel the appliance installation that is in progress.
post	Check Install Run sanity checks using the InstallSpec parameters passed.
post	Start Install Start the appliance installation.

Migrate

get	Get Migrate Get the MigrateSpec parameters used to configure the ongoing appliance migration.
post	Cancel Migrate Cancel the appliance migration that is in progress.
post	Check Migrate Run sanity checks using the MigrateSpec parameters passed.
post	Start Migrate Start the appliance migration.

Question

get	Get Question Get the question that was raised during the configuration.
post	Answer Question Supply answer to the raised question.

Upgrade

get	Get Upgrade Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
post	Cancel Upgrade Cancel the appliance upgrade that is in progress.
post	Check Upgrade Run sanity checks using the UpgradeSpec parameters passed.
post	Start Upgrade Start the appliance installation.

Install Remote PSC

post	Check Install Remote PSC Checks whether the remote PSC is reachable and the deployed vCenter Server can be registered with the remote PSC.

Install Initial Config Remote PSC Thumbprint

get	Get Install Initial Config Remote PSC Thumbprint Gets the SHA1 thumbprint of the remote PSC.

Install PSC Replicated

post	Check Install PSC Replicated Checks whether the provided remote PSC is reachable and can be replicated.

Install PSC Standalone

post	Check Install PSC Standalone Checks that the information to configure a non-replicated PSC satisfies the requirements.

Migrate Active Directory

post	Check Migrate Active Directory Checks whether the provided Active Directory user has permission to join the migrated vCenter Server appliance to the domain.

Guest

Customization Specs

post	Create 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 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.
get	Get 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 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.
delete	Delete 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.
post	Export 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 Specification 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 External Pool

get	Get Entropy External Pool Retrieves the entropy pool details of a host including current entropy level. if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Host.Entropy.Read.
post	Add Entropy External Pool Adds additional entropy to the pool. This API will accept maximum (ExternalPool.Info.capacity - ExternalPool.Info.currently-available) bytes of entropy. Extra entropy data sent will be discarded. if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Host.Entropy.Write.

HVC

Links

get	List Links Enumerates the list of registered hybrid links. Usage beyond VMware Cloud on AWS is not supported.
post	Create Links Creates a new hybrid link between the local and foreign PSC. Usage beyond VMware Cloud on AWS is not supported.
get	Get Links Gets information for a link. Usage beyond VMware Cloud on AWS is not supported.
delete	Delete Links Deletes an existing hybrid link. This API should be used when unlink is initiated from Cloud Gateway.
post	Delete With Credentials Links Deletes an existing hybrid link. This API should be used when unlink is initiated from cloud vCenter. Usage beyond VMware Cloud on AWS is not supported.

Management Administrators

get	Get Management Administrators Enumerates the set of all the groups in the local sso group. Usage beyond VMware Cloud on AWS is not supported.
put	Set Management Administrators Sets the groups in the local sso group. Usage beyond VMware Cloud on AWS is not supported.
post	Add Management Administrators Add the local sso group with the new group. Usage beyond VMware Cloud on AWS is not supported.
post	Remove Management Administrators Remove the group from the local sso group. Usage beyond VMware Cloud on AWS is not supported.

Identity

Providers

get	List Providers Retrieve all identity providers. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.
post	Create Providers Create a vCenter Server identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Create and VcIdentityProviders.Manage.
get	Get Providers Retrieve detailed information of the specified identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.
patch	Update Providers Update a vCenter Server identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.
delete	Delete Providers Delete a vCenter Server identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.

Broker Tenants Admin Client

get	Get Broker Tenants Admin Client Returns the tenant admin client token info associated with pre-configured tenant(s) owned by vcenter trustmanagment service. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.

Broker Tenants Operator Client

get

Get Broker Tenants Operator Client
Return the operator client token info in Broker. The operator client was created at bootstrap or installation of broker. This token can be used to manage tenant entity APIs. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.

Inventory

Datastore

get

Find Datastore
Returns datastore information for the specified datastores. The key in the result map is the datastore identifier and the value in the map is the datastore information. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource Datastore referenced by the parameter datastores requires System.Read.

Network

get

Find Network
Returns network information for the specified vCenter Server networks. The key in the result map is the network identifier and the value in the map is the network information. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource Network referenced by the parameter networks requires System.Read.

ISO

Image

post

Mount Image
Mounts an ISO image from a content library on a 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.Config.AddRemoveDevice. - The resource com.vmware.content.library.Item referenced by the parameter libraryItem requires ContentLibrary.DownloadSession.

post

Unmount Image
Unmounts a previously mounted CD-ROM using an ISO image as a backing. 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.Config.AddRemoveDevice. - The resource com.vmware.vcenter.vm.hardware.Cdrom referenced by the parameter cdrom requires System.Read.

LCM

Reports

get

Get Reports
Returns the location Reports.Location information for downloading the report for the specified file name. Retrieving a report involves two steps: - Step 1: Invoke the Reports.get operation to provision a token and a URI. - Step 2: Make an HTTP GET request by using the URI and the token returned in step 1 to retrieve the report. The HTTP GET request will: - Return 401 (Not Authorized) if the download URI is recognized, but the token is invalid, 404 if the URL is not recognized otherwise return 200 (OK) - Provide the CSV contents as the output of the request. The API accepts the file name as input, reads the contents of that CSV file, and returns this text as the result of the API.

Discovery Associated Products

post	Create Discovery Associated Products Associates a VMware product with vCenter Server manually. The product must be taken from the product catalog API.
get	List 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.
get	Get Discovery Associated Products Returns the detailed information of a product associated with vCenter Server.
patch	Update Discovery Associated Products Modifies a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be modified.
delete	Delete 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.

Discovery Interop Report

post

Create Discovery Interop Report Task
Creates interoperability report between a vCenter Server release version and all registered products with the vCenter Server instance. The result of this operation can be queried by calling the com.vmware.cis.Tasks#get operation where task is the response of this operation.

Discovery Product Catalog

get	List Discovery Product Catalog Retrieves a list of all VMware products that can be associated with vCenter Server.

Update Pending

get	List Update Pending Lists all available minor and major updates.
get	Get Update Pending Gets detailed update information.

Update Precheck Report

post

Create Update Precheck Report Task
Creates a vCenter Server pre-update compatibility check report for the pending update version. The report can be exported and downloaded in CSV format. The result of this operation can be queried by calling the com.vmware.cis.Tasks#get operation where task is the response of this operation.

Namespace Management

NSX Tier0 Gateway

get	List NSX Tier0 Gateway Returns information of NSX-T Tier0 Gateways associated with a Distributed Switch.

Cluster Available Versions

get	List Cluster Available Versions Get information about each available upgrade.

Cluster Compatibility

get	List Cluster Compatibility Returns Namespaces compatibility information for all vSphere clusters in the vCenter Server matching the ClusterCompatibility.FilterSpec. The result contains only visible (subject to permission checks) clusters.
get	List V2 Cluster Compatibility Returns Namespaces compatibility information for all vSphere clusters that match the #FilterSpecV2 and are associated with the vSphere Zones in the vCenter Server that match the #ZoneFilterSpec. The result contains only visible (subject to permission checks) clusters.

Cluster Size Info

get	Get Cluster Size Info Get information about the default values associated with various sizes.

Clusters

get	List Clusters Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.
put	Set Clusters Set a new configuration on the cluster object. The specified configuration is applied in entirety and will replace the current configuration fully.
patch	Update Clusters Update configuration on the cluster object. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.
get	Get Clusters Returns information about a specific cluster.
post	Disable Clusters Disable vSphere Namespaces on the cluster. This operation tears down the Kubernetes instance and the worker nodes associated with vSphere Namespaces enabled cluster.
post	Enable Clusters Enable vSphere Namespaces on the cluster. This operation sets up Kubernetes instance for the cluster along with worker nodes.
post	Rotate Password Clusters Request a new root password for all control plane nodes in the cluster. This operation generates a new root password and configures every control plane node in the cluster to accept it for authentication.

Distributed Switch Compatibility

get	List Distributed Switch Compatibility Returns Namespaces compatibility information of Distributed Switches in vCenter associated with the vCenter cluster, matching the DistributedSwitchCompatibility.FilterSpec.

Edge Cluster Compatibility

get	List Edge Cluster Compatibility Returns Namespaces compatibility information of NSX-T Edge Clusters matching the EdgeClusterCompatibility.FilterSpec.

Hosts Config

get	Get Hosts Config Returns support and licensing information about hosts under a VC.

Load Balancers

get	List Load Balancers Returns information about all load balancers associated with the given cluster.
get	Get Load Balancers Returns information LoadBalancers.Info about the load balancer associated with the given cluster.
put	Set Load Balancers Applies the entire load balancer spec to an existing load balancer configuration.
patch	Update Load Balancers Updates the load balancer configuration. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.

Namespace Resource Options

get	Get Namespace Resource Options Get the information about the objects used to set and update resource quota keys for version of Kubernetes running on {#link cluster}.

Networks

get	List Networks Return information about all vSphere Namespaces networks in the cluster.
post	Create Networks Create a vSphere Namespaces network object associated with the given cluster.
patch	Update Networks Update the configuration of the vSphere Namespaces network object associated with the given cluster.
delete	Delete Networks Delete the vSphere Namespaces object in the cluster.
get	Get Networks Return information about a specific vSphere Namespaces network.
put	Set Networks Set a new configuration for the vSphere Namespaces network object associated with the given cluster.

Supervisor Services

get	List Supervisor Services Return the information about all Supervisor Services on this vCenter.
post	Create 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	Get Supervisor Services Return the information for the specified Supervisor Service.
patch	Update Supervisor Services Update a Supervisor Service.
delete	Delete Supervisor Services 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.
patch	Activate Supervisor Services 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.
patch	Deactivate Supervisor Services 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.
post	Check Content 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.

Supervisors

post

Enable On Compute Cluster Supervisors
Enable the Supervisor on a single vSphere cluster. This operation sets up the Kubernetes instance for the cluster along with worker nodes. A #com.vmware.vcenter.consumption-domains.Zones zone will automatically be created if the specified cluster is not already associated with a vSphere Zone. To verify if the Supervisor is compatible with this vSphere cluster use: ClusterCompatibility.list. 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 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

Enable On Zones Supervisors
Enable a Supervisor on a set of vSphere Zones. The cluster control plane and its workloads will be eligible for placement across the zones. Enabling on multiple zones enables fault tolerance for applications deployed on more than one zone in case of a zone failure. To verify if the Supervisor is compatible with the provided Zones use: ClusterCompatibility.list.

Support Bundle

post

Create 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.

Virtual Machine Classes

get	List Virtual Machine Classes Return information about all VirtualMachine classes.
post	Create Virtual Machine Classes Create a VM class object.
get	Get Virtual Machine Classes Return information about a VM class.
patch	Update Virtual Machine Classes Update the configuration of the VM class object
delete	Delete Virtual Machine Classes Delete the VM class object.

Clusters Topology

get	Get Clusters Topology Queries the Supervisor ID that is currently running on the given vSphere Cluster ID, if there's any. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters.

Networks NSX Distributed Switches

get	List Networks NSX Distributed Switches Returns basic information of the Distributed Switches matching the DistributedSwitches.FilterSpec.

Networks NSX Edges

get	List Networks NSX Edges Returns a list of Edges matching the given filter.

Networks NSX Distributed Switches Compatibility

post	Check Networks NSX Distributed Switches Compatibility Returns a list of Distributed Switches matching the given filter and their compatibility information.

Networks NSX Edges Compatibility

post	Check Networks NSX Edges Compatibility Returns a list of Edges matching the given filter and their compatibility information.

Software Clusters

get	List Software Clusters Returns upgrade related information about all WCP enabled clusters.
get	Get Software Clusters Returns upgrade related information of a specific cluster.
post	Upgrade Software Clusters Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted
post	Upgrade Multiple Software Clusters Upgrade a set of clusters to its corresponding specific version.

Stats Time Series

get	Get Stats Time Series Gather statistical values for a cluster, namespace, or pod.

Storage Profiles

post	Check Storage Profiles Returns the compatible management storage profiles for enabling a WCP Supervisor across a given set of zones. A storage profile is compatible if it results in at least one datastore in each of the specified zones.

Supervisor Services Cluster Supervisor Services

get	List Supervisor Services Cluster 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.
post	Create Supervisor Services Cluster 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	Get Supervisor Services Cluster Supervisor Services 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 Supervisor Services Cluster Supervisor Services 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.
delete	Delete Supervisor Services Cluster Supervisor Services 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.

Supervisor Services Versions

get	List Supervisor Services Versions Return the information about all versions of the Supervisor Service.
post	Create Supervisor Services Versions Create a Supervisor Service version based on the provided service definition information for the version.
get	Get Supervisor Services Versions Return the information for the specified Supervisor Service version.
delete	Delete Supervisor Services Versions Delete a Supervisor Service version. This operation only deletes the Supervisor Service version from vCenter if the version is in DEACTIVATED state and all instances of the version are removed from all Supervisors. Note that the Versions.deactivate operation should be called to deactivate the version before the version can be deleted. Note that deleting the last version of the supervisorService does not delete the supervisorService instance automatically.
patch	Activate Supervisor Services Versions Activate a Supervisor Service version. This operation will change the Versions.State of the version to ACTIVATED state.
patch	Deactivate Supervisor Services Versions Deactivate a Supervisor Service version. This operation will change the Versions.State of the version to DEACTIVATED state, which will make sure the version cannot be created on any Supervisor cluster. Note that this operation should be called before deleting the version.

Supervisors Conditions

get	Get Supervisors Conditions Get all conditions of a given Supervisor.

Supervisors Summary

get	List Supervisors Summary Queries the current state of all Supervisors. Optionally, apply the filter to Supervisors that match the criteria in the Summary.FilterSpec.
get	Get Supervisors Summary Queries the current state of the specified Supervisor.

Supervisors Topology

get

Get Supervisors Topology
Queries the current association between vSphere Zones and vSphere Clusters from the given Supervisor ID. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. Use the vSphere Cluster IDs obtained from Topology.get to call the APIs that requires a vSphere Cluster ID instead of a Supervisor.

Supervisors Identity Providers

get	List Supervisors Identity Providers List the identity providers configured for a given Supervisor.
post	Create Supervisors Identity Providers Create a new identity provider to be used with a Supervisor. Currently, only a single identity provider can be created.
get	Get Supervisors Identity Providers Returns information about an identity provider configured for a Supervisor.
put	Set Supervisors Identity Providers Update the entire configuration for an existing identity provider used with a Supervisor.
patch	Update Supervisors Identity Providers Update an existing identity provider used with a Supervisor.
delete	Delete Supervisors Identity Providers Remove an identity provider configured with a given Supervisor. This will result in users no longer being able to log in to either the Supervisor or any of its workload clusters with that identity provider.

Namespaces

Access

delete	Delete Access Remove access control of the subject on given domain from the namespace.
get	Get Access Get the information about the access control of the subject on given domain on the namespace.
put	Set Access Set new access control on the namespace for the subject on given domain.
post	Create Access Set up access control for the subject on given domain on the namespace.

Instances

get	List Instances Returns the information about all namespaces in this vCenter Server. The information is tied to a single vSphere cluster.
post	Create Instances Create a namespace object on a single vSphere cluster.
get	Get Instances Returns information about a specific namespace on a single vSphere cluster.
put	Set 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 Instances Update the namespace object. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.
delete	Delete Instances Delete the namespace object in the cluster.
get	List V2 Instances Returns the information about all namespaces in this vCenter Server. The information is tied to a Supervisor.
post	Create V2 Instances Create a namespace object on a Supervisor.
get	Get V2 Instances Returns information about a specific namespace on a Supervisor.

Namespace Self Service

get	List Namespace Self Service Returns basic information about Namespace Self Service on all clusters on which vSphere Namespaces are enabled on this vCenter.
get	Get 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.
post	Activate 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 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 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.

Namespace Templates

get	List 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 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	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.
patch	Update Namespace Templates 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	List V2 Namespace Templates Returns information about all the namespace templates associated with a Supervisor.
post	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.
get	Get V2 Namespace Templates Get the information about a namespace template on a Supervisor.
patch	Update V2 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.

User Instances

get	List User Instances Returns namespaces matching the Instances.FilterSpec.

OVF

Export Flag

get

List Export Flag
Returns information about the supported export flags by the server. The supported flags are: PRESERVE_MAC: Include MAC addresses for network adapters. EXTRA_CONFIG: Include extra configuration in OVF export. Future server versions might support additional flags. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.

Import Flag

get

List Import Flag
Returns information about the import flags supported by the deployment platform. The supported flags are: LAX: Lax mode parsing of the OVF descriptor. Future server versions might support additional flags. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource ResourcePool referenced by the parameter rp requires System.Read.

Library Item

post	Create 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 null or null 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 Library Item 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 Library Item 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

Service

get	List Details Service Lists details of vCenter services.
get	Get Service Returns the state of a service.
patch	Update Service Updates the properties of a service.
post	Restart Service Restarts a service
post	Start Service Starts a service
post	Stop Service Stops a service

Storage

Policies

get	List Policies Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter. These storage policies can be used for provisioning virtual machines or disks.
post	Check Compatibility Policies Returns datastore compatibility summary about a specific storage policy.

Policies VM

get	List Policies VM Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.

Policies Compliance

get	List Policies Compliance Returns compliance information about entities matching the filter Compliance.FilterSpec. Entities without storage policy association are not returned.

Policies Compliance VM

get	List Policies Compliance VM Returns compliance information about at most 1000 virtual machines matching the filter VM.FilterSpec. If there are no virtual machines matching the VM.FilterSpec an empty List is returned. Virtual machines without storage policy association are not returned.

System Config

Deployment Type

get	Get Deployment Type Get the type of the vCenter appliance.
put	Reconfigure Deployment Type Reconfigure the type of the vCenter appliance.

PSC Registration

get	Get PSC Registration Get information of the PSC that this appliance is registered with.
post	Repoint PSC Registration Repoint this vCenter Server appliance to a different external PSC.

Tagging

Associations

get	List Associations Returns tag associations that match the specified iteration spec.

Topology

Nodes

get	List Nodes Returns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
get	Get Nodes Retrieve details for a given identifier of the vCenter or Platform Services Controller node. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.

Replication Status

get

List Replication Status
Returns the replication information of vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see Nodes.Info.type) matching the ReplicationStatus.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.

Trusted Infrastructure

Principal

get	Get Principal Returns information about the STS used by this vCenter instance. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadStsInfo.

Trust Authority Clusters

get	List Trust Authority Clusters Returns a list of clusters for this vCenter instance which matches the TrustAuthorityClusters.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the attribute TrustAuthorityClusters.FilterSpec.cluster requires System.View.
get	Get Trust Authority Clusters Get the result of the last Update operation which matches the cluster id. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the parameter cluster requires System.View.
patch	Update Trust Authority Clusters Task Updates the state of a cluster.

Attestation Services

post	Create Attestation Services Registers a new Attestation Service instance in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ManageTrustedHosts.
get	Get Attestation Services Returns the detailed information about a registered Attestation Service instance in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts.
delete	Delete Attestation Services Removes a registered Attestation Service instance from this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ManageTrustedHosts.
post	List Attestation Services Returns detailed information about all registered Attestation Service instances in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts.

Hosts Hardware TPM

get	List Hosts Hardware TPM Return a list of configured TPMs 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.
get	Get Hosts Hardware TPM Get the TPM details 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.

Hosts Hardware TPM Endorsement Keys

get	List Hosts Hardware TPM 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.
get	Get Hosts Hardware TPM 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.
post	Unseal Hosts Hardware TPM Endorsement Keys 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.

Hosts Hardware TPM Event Log

get	Get Hosts Hardware TPM Event Log Retrieves the event log associated with the TPM device. if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.

KMS Services

post	Create KMS Services Registers a Key Provider Service instance in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ManageTrustedHosts.
get	Get KMS Services Returns the detailed information about a registered Key Provider Service instance in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts.
delete	Delete KMS Services Removes a currently registered Key Provider Service instance from this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ManageTrustedHosts.
post	List KMS Services Returns basic information about all registered Key Provider Service instances in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts.

Trust Authority Clusters Consumer Principals

get	Get Trust Authority Clusters Consumer Principals Task Retrieve information for a specific profile.
delete	Delete Trust Authority Clusters Consumer Principals Task Removes the read-only policy configured on ESX for a specific principal.
post	List Trust Authority Clusters Consumer Principals Task Lists all policies configured on a specific cluster.
post	Create Trust Authority Clusters Consumer Principals Task Creates a profile with the specified connection information on all hosts from a Trust Authority Cluster.

Trust Authority Clusters Attestation Service Status

get	Get Trust Authority Clusters Attestation Service Status Task Return the Attestation service health in the given cluster.

Trust Authority Clusters Attestation OS ESX Base Images

get	Get Trust Authority Clusters Attestation OS ESX Base Images Task Get the trusted ESX base version details.
delete	Delete Trust Authority Clusters Attestation OS ESX Base Images Task Remove a trusted ESX base image of each ESX in the cluster.
post	Import From IMGDB Trust Authority Clusters Attestation OS ESX Base Images Task Import ESX metadata as a new trusted base image to each host in the cluster. Import a boot_imgdb.tgz file which contains metadata that describes a trusted ESX base image. A boot_imgdb.tgz file can be downloaded from a representative host.
get	List Trust Authority Clusters Attestation OS ESX Base Images Task Return a list of trusted ESX base images.

Trust Authority Clusters Attestation TPM2 CA Certificates

get	Get Trust Authority Clusters Attestation TPM2 CA Certificates Task Get the TPM CA certificate details on a cluster.
delete	Delete Trust Authority Clusters Attestation TPM2 CA Certificates Task Remove a TPM CA certificate on a cluster.
get	List Trust Authority Clusters Attestation TPM2 CA Certificates Task Return a list of configured TPM CA certificates on a cluster.
post	Create Trust Authority Clusters Attestation TPM2 CA Certificates Task Add a new TPM CA certificate on a cluster.

Trust Authority Clusters Attestation TPM2 Endorsement Keys

get	Get Trust Authority Clusters Attestation TPM2 Endorsement Keys Task Get the TPM endorsement key details on a cluster.
delete	Delete Trust Authority Clusters Attestation TPM2 Endorsement Keys Task Remove a TPM endorsement key on a cluster.
post	Create Trust Authority Clusters Attestation TPM2 Endorsement Keys Task Add a new TPM endorsement key on a cluster.
get	List Trust Authority Clusters Attestation TPM2 Endorsement Keys Task Return a list of configured TPM endorsement keys in a cluster.

Trust Authority Clusters Attestation TPM2 Settings

get	Get Trust Authority Clusters Attestation TPM2 Settings Task Return the TPM 2.0 protocol settings.
patch	Update Trust Authority Clusters Attestation TPM2 Settings Task Set the TPM 2.0 protocol settings.

Trust Authority Clusters KMS Providers

get	Get Trust Authority Clusters KMS Providers Task Return information about a Key Provider.
patch	Update Trust Authority Clusters KMS Providers Task Update an existing Key Provider.
delete	Delete Trust Authority Clusters KMS Providers Task Remove a Key Provider.
get	List Trust Authority Clusters KMS Providers Task Return a list of summary of Key Providers.
post	Create Trust Authority Clusters KMS Providers Task Add a new Key Provider.

Trust Authority Clusters KMS Service Status

get	Get Trust Authority Clusters KMS Service Status Task Return the Key Provider Service health in the given cluster.

Trust Authority Clusters KMS Providers Client Certificate

get	Get Trust Authority Clusters KMS Providers Client Certificate Task Return the existing client certificate.
post	Create Trust Authority Clusters KMS Providers Client Certificate Task Generate a new self signed client certificate. Existing client certificate is overwritten. The key server will use this certificate to validate the client connection.
patch	Update Trust Authority Clusters KMS Providers Client Certificate Task Update the client certificate. The key server will use this certificate to validate the client connection. If a client certificate already exists, it will be replaced. An optional private key can be specified if the certificate has already been provisioned.

Trust Authority Clusters KMS Providers Credential

put	Set Trust Authority Clusters KMS Providers Credential Task Set the key server credential.

Trust Authority Clusters KMS Providers Current Peer Certificates

get

List Trust Authority Clusters KMS Providers Current Peer Certificates Task
Return the remote server certificates. Contacts the configured key servers and attempts to retrieve their certificates. These certificates might not yet be trusted. If the returned certificates are to be considered trustworthy, then it must be added to the list of trusted server certificates by adding to the certificates returned by TrustedPeerCertificates.get and invoking TrustedPeerCertificates.update with the updated list of certificates.

Trust Authority Clusters KMS Providers Trusted Peer Certificates

get	Get Trust Authority Clusters KMS Providers Trusted Peer Certificates Task Return the list of trusted server certificates.
patch	Update Trust Authority Clusters KMS Providers Trusted Peer Certificates Task Update trusted server certificate(s). The client will use these certificates to validate the server connection. The existing list of trusted certificates will be overwritten. The client will not trust the server connection until a server certificate has been set.

Trust Authority Clusters KMS Providers Client Certificate CSR

get	Get Trust Authority Clusters KMS Providers Client Certificate CSR Task Get existing certificate signing request (CSR) for the client certificate. The CSR will allow the certificate to be signed by a third party. Once the CSR is signed, certificate may be added as a client certificate.
post	Create Trust Authority Clusters KMS Providers Client Certificate CSR Task Generate a certificate signing request (CSR) for the client certificate. This overwrites any existing CSR. The CSR will allow the certificate to be signed by a third party. Once the CSR is signed, certificate may be added as a client certificate. Calling the API repeatedly will result in a generating a new CSR each time.

Trust Authority Hosts Attestation

post

List Trust Authority Hosts Attestation
Returns a list of the hosts running a Attestation Service matching the specified Attestation.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource HostSystem referenced by the attribute Attestation.FilterSpec.hosts requires System.View. - The resource ClusterComputeResource referenced by the attribute Attestation.FilterSpec.clusters requires System.View.

get

Get Trust Authority Hosts Attestation
Returns the connection info about the Attestation Service running on the specified host. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource HostSystem referenced by the parameter host requires System.View.

Trust Authority Hosts KMS

get

Get Trust Authority Hosts KMS
Returns the connection info about the Key Provider Service running on the specified host. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource HostSystem referenced by the parameter host requires System.View.

post

List Trust Authority Hosts KMS
Returns a list of the hosts running a Key Provider Service matching the specified Kms.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource HostSystem referenced by the attribute Kms.FilterSpec.hosts requires System.View. - The resource ClusterComputeResource referenced by the attribute Kms.FilterSpec.clusters requires System.View.

Trusted Clusters Services Applied Config

delete	Delete Trusted Clusters Services Applied Config Task Delete all Trust Authority Components configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Trust Authority Component configurations from any Trusted Hosts within the given cluster.
get	Get Trusted Clusters Services Applied Config Task Returns detailed information about the health of the applied Trust Authority Component configurations in the given cluster.
patch	Update Trusted Clusters Services Applied Config Task Update all applied Trust Authority Component configuration on the given cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation. If the cluster is not a Trusted Cluster, the method will remove all Trust Authority Component configuration from the Trusted Hosts in the cluster, if such hosts are found.

Trusted Clusters Attestation Services

get	Get Trusted Clusters Attestation Services Returns detailed information about the given registered Attestation Service instance that is configured for the given cluster. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the parameter cluster requires System.View.
delete	Delete Trusted Clusters Attestation Services Task Removes the Attestation Service instance from the configuration of the given cluster.
post	List Trusted Clusters Attestation Services Returns the basic information about all configured Attestation Service instances used by this cluster. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the parameter cluster requires System.View.
post	Create Trusted Clusters Attestation Services Task Configures the cluster to use a the given registered Attestation Service.

Trusted Clusters Attestation Services Applied Config

post	List Trusted Clusters Attestation Services Applied Config Task Returns basic information about the health of all Attestation Service configurations applied to the cluster with respect to the desired state.
patch	Update Trusted Clusters Attestation Services Applied Config Task Update the applied Attestation Service configuration on the given Trusted Cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation.
delete	Delete Trusted Clusters Attestation Services Applied Config Task Delete the Attestation Service configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Attestation Service configuration from any Trusted Hosts within the given cluster.
get	Get Trusted Clusters Attestation Services Applied Config Task Returns detailed information about the health of the specified Attestation Service configuration applied to the cluster with respect to the desired state.

Trusted Clusters KMS Services

get	Get Trusted Clusters KMS Services Returns detailed information about the given Key Provider Service instance used by the given cluster. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the parameter cluster requires System.View.
delete	Delete Trusted Clusters KMS Services Task Removes the Key Provider Service instance from the configuration of the given cluster.
post	List Trusted Clusters KMS Services Returns basic information about all configured Key Provider Service instances used by this cluster. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the parameter cluster requires System.View.
post	Create Trusted Clusters KMS Services Task Configures the cluster to use a the given registered Key Provider Service.

Trusted Clusters KMS Services Applied Config

post	List Trusted Clusters KMS Services Applied Config Task Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state.
get	Get Trusted Clusters KMS Services Applied Config Task Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state.
patch	Update Trusted Clusters KMS Services Applied Config Task Update the applied Key Provider Service configuration on the given Trusted Cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation.
delete	Delete Trusted Clusters KMS Services Applied Config Task Delete the Key Provider Service configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Key Provider Service configuration from any Trusted Hosts within the given cluster.

vCenter

get	List VM Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec.
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	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.
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.
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 Task 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.
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 Task 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	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.

Cluster

get	List Cluster Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec.
get	Get Cluster Retrieves information about the cluster corresponding to cluster. if you do not have all of the privileges described as follows: - The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Datacenter

get	List Datacenter Returns information about at most 1000 visible (subject to permission checks) datacenters in vCenter matching the Datacenter.FilterSpec.
post	Create Datacenter Create a new datacenter in the vCenter inventory
get	Get Datacenter Retrieves information about the datacenter corresponding to datacenter.
delete	Delete Datacenter Delete an empty datacenter from the vCenter Server

Datastore

get	List Datastore Returns information about at most 2500 visible (subject to permission checks) datastores in vCenter matching the Datastore.FilterSpec.
get	Get Datastore Retrieves information about the datastore indicated by datastore.

Deployment

get	Get Deployment Get the current status of the appliance deployment.
post	Rollback Deployment Rollback a failed appliance so it can be configured once again.

Folder

get	List Folder Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec.

Host

get	List Host Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.
post	Create Host Add a new standalone host in the vCenter inventory. The newly connected host will be in connected state. The vCenter Server will verify the SSL certificate before adding the host to its inventory. In the case where the SSL certificate cannot be verified because the Certificate Authority is not recognized or the certificate is self signed, the vCenter Server will fall back to thumbprint verification mode as defined by Host.CreateSpec.ThumbprintVerification.
delete	Delete Host Remove a standalone host from the vCenter Server.
post	Connect Host Connect to the host corresponding to host previously added to the vCenter server.
post	Disconnect Host Disconnect the host corresponding to host from the vCenter server

Network

get	List Network Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec.

Resource Pool

get	List Resource Pool Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePool.FilterSpec.
post	Create Resource Pool Creates a resource pool. if you do not have all of the privileges described as follows: - The resource ResourcePool referenced by the attribute ResourcePool.CreateSpec.parent requires Resource.CreatePool.
get	Get Resource Pool Retrieves information about the resource pool indicated by resourcePool. if you do not have all of the privileges described as follows: - The resource ResourcePool referenced by the parameter resourcePool requires System.Read.
patch	Update Resource Pool Updates the configuration of a resource pool. if you do not have all of the privileges described as follows: - The resource ResourcePool referenced by the parameter resourcePool requires Resource.EditPool.
delete	Delete Resource Pool Deletes a resource pool.

VCHA

Cluster

post	Deploy Cluster Task Prepares, clones, and configures a VCHA cluster.
post	Failover Cluster Task Initiates failover from the active vCenter node to the passive node. For forced failover, Active node immediately initiates a failover. This may result into a data loss after failover. For planned failover, Active node flushes all the state to the Passive node, waits for the flush to complete before causing a failover. After the failover, Passive node starts without any data loss. A failover is allowed only in the following cases: 1. Cluster's mode is enabled and all cluster members are present. 2. Cluster's mode is maintenance and all cluster members are present.
post	Get Cluster Retrieves the status of a VCHA cluster.
post	Undeploy Cluster Task Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance. Optionally, the passive and witness node virtual machines will be deleted only if VCHA was deployed using automatic deployment. The active node in the cluster continues to run as a standalone VCVA appliance after the destroy operation has been performed. If the VCHA cluster is in a transition state and not configured, then the VCHA cluster specific information is removed.

Operations

get	Get Operations Retrieves the current active and disabled operations of a VCHA cluster.

Cluster Active

post	Get Cluster Active Retrieves information about the active node of a VCHA cluster.

Cluster Deployment Type

get	Get Cluster Deployment Type Retrieves the deployment type of a VCHA cluster.

Cluster Mode

get

Get Cluster Mode
Retrieves the current mode of a VCHA cluster.

put

Set Cluster Mode Task
Manipulates the mode of a VCHA Cluster. Following mode transitions are allowed: enabled -> disabled - Allowed only in healthy and degraded states. enabled -> maintenance - Allowed only in healthy state. disabled -> enabled - Allowed only in healthy state. maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version. maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version. All other transitions are not allowed. VCHA Cluster configuration remains intact in any of the cluster modes.

Cluster Passive

post	Check Cluster Passive Validates the specified passive node's placement configuration.
post	Redeploy Cluster Passive Task Creates the passive node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.

Cluster Witness

post	Check Cluster Witness Validates the specified witness node's placement configuration.
post	Redeploy Cluster Witness Task Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.

VM

Data Sets

get	List Data Sets Lists the data sets of 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.DataSets.DataSetList.
post	Create Data Sets Creates a new data set. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetCreate.
get	Get Data Sets Returns information describing a data set. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetGet.
patch	Update Data Sets Modifies the attributes of a data set. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetUpdate.
delete	Delete Data Sets Delete a data set. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetDelete.

Hardware

patch	Update Hardware Updates the virtual hardware settings of a virtual machine.
get	Get Hardware Returns the virtual hardware settings of a virtual machine.
post	Upgrade Hardware Upgrades the virtual machine to a newer virtual hardware version.

Library Item

get	Get Library Item Returns the information about the library item associated with the virtual machine.

Power

get	Get Power Returns the power state information of 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	Reset Power Resets a powered-on virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Reset.
post	Start Power Powers on a powered-off or suspended virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOn.
post	Stop Power Powers off a powered-on or suspended virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOff.
post	Suspend Power Suspends a powered-on virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Suspend.

Tools

get	Get Tools Get the properties of VMware Tools.
patch	Update Tools Update the properties of VMware Tools.
post	Upgrade Tools Begins the Tools upgrade process. To monitor the status of the Tools upgrade, clients should check the Tools status by calling Tools.get and examining Tools.Info.version-status and Tools.Info.run-state.

Compute Policies

get	Get Compute Policies Returns information about the compliance of a virtual machine with a compute policy.

Console Tickets

post

Create Console Tickets
Creates a virtual machine console ticket of a given ticket type. The created ticket is a one time use URI. The validity of the ticket is 30 minutes, if not used with in the time frame the ticket expires. The VMRC ticket contains the IP address or the DNS resolvable name of the vCenter server. This ticket requires installation of VMware Workstation, VMware Fusion or VMRC to be installed on the machine where the ticket has to be opened. This ticket can be acquired even when the VM is turned off. The WEBMKS ticket contains the IP address of the DNS resolvable name of the ESX server. This ticket requires user to embed this ticket in a HTML page using VMware HTML Console SDK - https://www.vmware.com/support/developer/html-console This ticket can be acquired only when the VM is turned on.

Data Sets Entries

get	List Data Sets Entries Lists all entry keys in a data set. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntryList.
get	Get Data Sets Entries Retrieves the value of an entry in a data set. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntryGet.
put	Set Data Sets Entries Creates or updates an entry in a data set. If an entry whose key matches key already exists, it will replace the existing value, otherwise it will create a new entry. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntrySet.
delete	Delete Data Sets Entries Deletes an entry in a data set. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntryDelete.

Guest Customization

get

Get Guest Customization
Returns the status of the customization operation that has been applied for the virtual machine in vm. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires System.View.

put

Set Guest Customization
Applies a customization specification in spec on the virtual machine in vm. This operation only sets the specification settings for the virtual machine. The actual customization happens inside the guest when the virtual machine is powered on. If spec has unset values, then any pending customization settings for the virtual machine are cleared. If there is a pending customization for the virtual machine and spec has valid content, then the existing customization setting will be overwritten with the new settings. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Provisioning.Customize.

Guest Environment

post

Get Guest Environment
Reads a single environment variable from the guest operating system. If the authentication uses Credentials.interactive-session, then the environment being read will be that of the user logged into the desktop. Otherwise it's the environment of the system user. 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 Guest Environment
Reads a list of environment variables from the guest operating system. If the authentication uses Credentials.interactive-session, then the environment being read will be that of the user logged into the desktop. Otherwise it's the environment of the system user. 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 Identity

get	Get Guest Identity Return information about the guest.

Guest Local Filesystem

get	Get Guest Local Filesystem Returns details of the local file systems in the guest operating system.

Guest Networking

get	Get Guest Networking Returns information about the network configuration in the guest operating system.

Guest Operations

get	Get Guest Operations Get information about the guest operation status. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires System.Read.

Guest Power

get	Get Guest Power Returns information about the guest operating system power state.
post	Reboot Guest Power Issues a request to the guest operating system asking it to perform a reboot. This request returns immediately and does not wait for the guest operating system to complete the operation.
post	Shutdown Guest Power Issues a request to the guest operating system asking it to perform a clean shutdown of all services. This request returns immediately and does not wait for the guest operating system to complete the operation.
post	Standby Guest Power Issues a request to the guest operating system asking it to perform a suspend operation.

Guest Processes

post	Delete Guest 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 Guest 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	Create 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	List 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 Guest 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 Guest 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 Guest 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 Guest 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	Delete Guest Filesystem 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 Guest Filesystem 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	Create Temporary Guest 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	List Guest 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 Guest 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 Guest 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.

Guest Filesystem Transfers

post

Create Guest Filesystem Transfers
Initiates an operation to transfer a file to or from the guest. If the power state of the Virtual Machine is changed when the file transfer is in progress, or the Virtual Machine is migrated, then the transfer operation is aborted. When transferring a file into the guest and overwriting an existing file, the old file attributes are not preserved. In order to ensure a secure connection to the host when transferring a file using HTTPS, the X.509 certificate for the host must be used to authenticate the remote end of the connection. The certificate of the host that the virtual machine is running on can be retrieved using the following fields: XXX insert link to certificate in Host config XXX 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 Networking Interfaces

get	List Guest Networking Interfaces Returns information about the networking interfaces in the guest operating system.

Guest Networking Routes

get	List Guest Networking Routes Returns information about network routing in the guest operating system.

Hardware Boot

get	Get Hardware Boot Returns the boot-related settings of a virtual machine.
patch	Update Hardware Boot Updates the boot-related settings of a virtual machine.

Hardware CD-ROM

get	List Hardware CD ROM Returns commonly used information about the virtual CD-ROM devices belonging to the virtual machine.
post	Create Hardware CD ROM Adds a virtual CD-ROM device to the virtual machine.
get	Get Hardware CD ROM Returns information about a virtual CD-ROM device.
patch	Update Hardware CD ROM Updates the configuration of a virtual CD-ROM device.
delete	Delete Hardware CD ROM Removes a virtual CD-ROM device from the virtual machine.
post	Connect Hardware CD ROM Connects a virtual CD-ROM device of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Cdrom.update operation may be used to configure the virtual CD-ROM device to start in the connected state when the virtual machine is powered on.
post	Disconnect Hardware CD ROM Disconnects a virtual CD-ROM device of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the CD-ROM device is not connected to its backing resource. For a powered-off virtual machine, the Cdrom.update operation may be used to configure the virtual CD-ROM device to start in the disconnected state when the virtual machine is powered on.

Hardware CPU

get	Get Hardware CPU Returns the CPU-related settings of a virtual machine.
patch	Update Hardware CPU Updates the CPU-related settings of a virtual machine.

Hardware Disk

get	List Hardware Disk Returns commonly used information about the virtual disks belonging to the virtual machine.
post	Create Hardware Disk Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.
get	Get Hardware Disk Returns information about a virtual disk.
patch	Update Hardware Disk Updates the configuration of a virtual disk. An update operation can be used to detach the existing VMDK file and attach another VMDK file to the virtual machine.
delete	Delete Hardware Disk Removes a virtual disk from the virtual machine. This operation does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

Hardware Ethernet

get	List Hardware Ethernet Returns commonly used information about the virtual Ethernet adapters belonging to the virtual machine.
post	Create Hardware Ethernet Adds a virtual Ethernet adapter to the virtual machine.
get	Get Hardware Ethernet Returns information about a virtual Ethernet adapter.
patch	Update Hardware Ethernet Updates the configuration of a virtual Ethernet adapter.
delete	Delete Hardware Ethernet Removes a virtual Ethernet adapter from the virtual machine.
post	Connect Hardware Ethernet Connects a virtual Ethernet adapter of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Ethernet.update operation may be used to configure the virtual Ethernet adapter to start in the connected state when the virtual machine is powered on.
post	Disconnect Hardware Ethernet Disconnects a virtual Ethernet adapter of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the Ethernet adapter is not connected to its backing resource. For a powered-off virtual machine, the Ethernet.update operation may be used to configure the virtual Ethernet adapter to start in the disconnected state when the virtual machine is powered on.

Hardware Floppy

get	List Hardware Floppy Returns commonly used information about the virtual floppy drives belonging to the virtual machine.
post	Create Hardware Floppy Adds a virtual floppy drive to the virtual machine.
get	Get Hardware Floppy Returns information about a virtual floppy drive.
patch	Update Hardware Floppy Updates the configuration of a virtual floppy drive.
delete	Delete Hardware Floppy Removes a virtual floppy drive from the virtual machine.
post	Connect Hardware Floppy Connects a virtual floppy drive of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Floppy.update operation may be used to configure the virtual floppy drive to start in the connected state when the virtual machine is powered on.
post	Disconnect Hardware Floppy Disconnects a virtual floppy drive of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the floppy drive is not connected to its backing resource. For a powered-off virtual machine, the Floppy.update operation may be used to configure the virtual floppy floppy to start in the disconnected state when the virtual machine is powered on.

Hardware Memory

get	Get Hardware Memory Returns the memory-related settings of a virtual machine.
patch	Update Hardware Memory Updates the memory-related settings of a virtual machine.

Hardware Parallel

get	List Hardware Parallel Returns commonly used information about the virtual parallel ports belonging to the virtual machine.
post	Create Hardware Parallel Adds a virtual parallel port to the virtual machine.
get	Get Hardware Parallel Returns information about a virtual parallel port.
patch	Update Hardware Parallel Updates the configuration of a virtual parallel port.
delete	Delete Hardware Parallel Removes a virtual parallel port from the virtual machine.
post	Connect Hardware Parallel Connects a virtual parallel port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Parallel.update operation may be used to configure the virtual parallel port to start in the connected state when the virtual machine is powered on.
post	Disconnect Hardware Parallel Disconnects a virtual parallel port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the parallel port is not connected to its backing. For a powered-off virtual machine, the Parallel.update operation may be used to configure the virtual parallel port to start in the disconnected state when the virtual machine is powered on.

Hardware Serial

get	List Hardware Serial Returns commonly used information about the virtual serial ports belonging to the virtual machine.
post	Create Hardware Serial Adds a virtual serial port to the virtual machine.
patch	Update Hardware Serial Updates the configuration of a virtual serial port.
delete	Delete Hardware Serial Removes a virtual serial port from the virtual machine.
get	Get Hardware Serial Returns information about a virtual serial port.
post	Connect Hardware Serial Connects a virtual serial port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Serial.update operation may be used to configure the virtual serial port to start in the connected state when the virtual machine is powered on.
post	Disconnect Hardware Serial Disconnects a virtual serial port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the serial port is not connected to its backing. For a powered-off virtual machine, the Serial.update operation may be used to configure the virtual serial port to start in the disconnected state when the virtual machine is powered on.

Hardware Adapter NVMe

get	List Hardware Adapter NVMe Returns commonly used information about the virtual NVMe adapters belonging to the virtual machine.
post	Create Hardware Adapter NVMe Adds a virtual NVMe adapter to the virtual machine.
get	Get Hardware Adapter NVMe Returns information about a virtual NVMe adapter.
delete	Delete Hardware Adapter NVMe Removes a virtual NVMe adapter from the virtual machine.

Hardware Adapter SATA

get	List Hardware Adapter SATA Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.
post	Create Hardware Adapter SATA Adds a virtual SATA adapter to the virtual machine.
get	Get Hardware Adapter SATA Returns information about a virtual SATA adapter.
delete	Delete Hardware Adapter SATA Removes a virtual SATA adapter from the virtual machine.

Hardware Adapter SCSI

get	List Hardware Adapter SCSI Returns commonly used information about the virtual SCSI adapters belonging to the virtual machine.
post	Create Hardware Adapter SCSI Adds a virtual SCSI adapter to the virtual machine.
get	Get Hardware Adapter SCSI Returns information about a virtual SCSI adapter.
patch	Update Hardware Adapter SCSI Updates the configuration of a virtual SCSI adapter.
delete	Delete Hardware Adapter SCSI Removes a virtual SCSI adapter from the virtual machine.

Hardware Boot Device

get

Get Hardware Boot Device
Returns an ordered list of boot devices for the virtual machine. If the list is empty, the virtual machine uses a default boot sequence.

put

Set Hardware Boot Device
Sets the virtual devices that will be used to boot the virtual machine. The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the list is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of Device.Entry for a given device type except ETHERNET in the list.

Storage Policy

get	Get Storage Policy Returns Information about Storage Policy associated with a virtual machine's home directory and/or its virtual hard disks.
patch	Update Storage Policy Updates the storage policy configuration of a virtual machine and/or its associated virtual hard disks.

Storage Policy Compliance

get	Get Storage Policy Compliance Returns the cached storage policy compliance information of a virtual machine.
post	Check Storage Policy Compliance Returns the storage policy Compliance Compliance.Info of a virtual machine after explicitly re-computing compliance check.

Tools Installer

get	Get Tools Installer Get information about the VMware Tools installer.
post	Connect Tools Installer Connects the VMware Tools CD installer as a CD-ROM for the guest operating system. On Windows guest operating systems with autorun, this should cause the installer to initiate the Tools installation which will need user input to complete. On other (non-Windows) guest operating systems this will make the Tools installation available, and a a user will need to do guest-specific actions. On Linux, this includes opening an archive and running the installer. To monitor the status of the Tools install, clients should check the Tools.Info.version-status and Tools.Info.run-state from Tools.get
post	Disconnect Tools Installer Disconnect the VMware Tools installer CD image.

VM Template

Library Items

post	Create 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.
get	Get Library Items 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.
post	Deploy 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.

Library Items Check Outs

get	List Library Items 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.
get	Get Library Items 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.
delete	Delete Library Items 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.
post	Check In Library Items 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 Library Items 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.

Library Items Versions

get	List Library Items 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.
get	Get Library Items Versions 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.
delete	Delete Library Items Versions 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.
post	Rollback Library Items Versions 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.

vCenter REST APIs Operations Index

Authentication

Authorization

Certificate Management

Compute

Confidential Computing

Consumption Domains

Content

Crypto Manager

Datastore

Deployment

Guest

Host

HVC

Identity

Inventory

ISO

LCM

Namespace Management

Namespaces

OVF

Services

Storage

System Config

Tagging

Topology

Trusted Infrastructure

vCenter

VCHA

VM

VM Template

Was this page helpful?