Vcenter APIs

The Vcenter Authorization Permissions resource provides operations to create, update, delete and retrieve authorization permissions in the vCenter Server.

The authorization permissions are the actual access-control rules. There are currently two kinds of permissions - global and inventory permissions. But in the future we could support more.

An inventory permission is defined on an resource which is part of vCenter's inventory and specifies the user or group to which the rule applies. The role specifies the privileges to apply, and the propagate flag specifies whether or not the rule applies to the sub-resources of the inventory.

A resource may have multiple permissions, but can have only one permission per user or group. If, when logging in, a user has both a user permission and a group permission (as a group member) for the same resource, then the user-specific permission takes precedent. If there is no user-specific permission, but two or more group permissions are present, and the user is a member of the groups, then the privileges are the union of the specified roles.

There global permissions are assigned without specifying a resource. These permissions, if set as propagated, could propagated down to all resources, including inventory.

This resource was added in vSphere API 9.0.0.0.

The Vcenter Authorization PrivilegeChecks resource provides operations for retrieving permission privilege checks recorded by VPXD.

The privilege checks are recorded as VPXD makes them. The latest recorded privilege check can be retrieved by a call to com.vmware.vcenter.authorization.privilege_checks.Latest.get This allows for querying of all privilege checks before or after that moment. For example, if an administrator wants to record the privilege checks made by a given UI workflow, they can do the following. 1. Retrieve the latest privilege check and store it. 2. Go through the UI workflow. 3. Retrieve the latest privilege check and store it. 4. Invoke com.vmware.vcenter.authorization.PrivilegeChecks.list with the values from steps 1) and 3) along with any additional filters.

This resource was added in vSphere API 8.0.0.0.

The LatestPrivilegeChecks resource provides operations for getting the latest recorded privilege check.

This resource was added in vSphere API 8.0.0.0.

The Vcenter Authorization Privileges resource provides operations to query and retrieve authorization privileges in the vCenter Server.

Privileges are the most fine grained rights required by operations in order to be performed. They are statically defined in the vCenter Server.

This resource was added in vSphere API 9.0.0.0.

The Vcenter Authorization Roles resource provides operations to create, update, delete and retrieve authorization roles in the vCenter Server.

The authorization role is a collection of Vcenter Authorization Privileges which are grouped in a such way that they are related to a specific functionality.

Each user defined authorization role contains at minimum three specific Vcenter Authorization Privileges "System.Anonymous", "System.View", "System.Read".

This resource was added in vSphere API 9.0.0.0.

The Vcenter Authorization VtContainers Mappings resource can be used to manage the relationship between containerized objects and vTContainer instances. A containerized object is any data object that is associated with a vTContainer instance, and can be of any resource type.

Each vTContainer instance can hold any number of containerized objects, but there is a service defined limit to the number of vTContainer instances that can be associated with a single containerized object.

When a containerized object is deleted, its mappings to vTContainer instances are automatically removed. However, a vTContainer instance cannot be deleted until all mappings to it have been removed.

This resource was added in vSphere API 8.0.3.0.

The Vcenter CertificateManagement Vcenter SigningCertificate interface provides operations to view and manage vCenter signing certificates which are used to sign and verify tokens issued by vCenter token service. Versioning is the same as for the com.vmware.vcenter package. 1.23 - vSphere 7.0 U3

This resource was added in vSphere API 7.0.3.0.

The Vcenter CertificateManagement Vcenter Tls interface provides operations to replace Tls certificate.

This resource was added in vSphere API 6.7.2.

The Vcenter CertificateManagement Vcenter TlsCsr interface provides operations to generate certificate signing request.

This resource was added in vSphere API 6.7.2.

The Vcenter CertificateManagement Vcenter TrustedRootChains interface provides operations to create, modify, delete and read trusted root certificate chains.

This resource was added in vSphere API 6.7.2.

The Vcenter CertificateManagement Vcenter VmcaRoot interface provides operations to replace VMware Certificate Authority (VMCA) root certificate.

This resource was added in vSphere API 6.9.1.

The Vcenter Cluster resource provides operations to manage clusters in the vCenter Server.

The Vcenter Cluster EvcMode resource provides operations to manage Vcenter Cluster EvcMode settings for a cluster.

This resource was added in vSphere API 9.0.0.0.

The Vcenter ConfidentialComputing Sgx Hosts resources provides operations to register Intel Software Guard Extensions (SGX) for the hosts.

This resource was added in vSphere API 8.0.0.1.

The CLUSTER resource provides operations to query zone-cluster associations.

This resource was added in vSphere API 8.0.0.1.

The Vcenter ConsumptionDomains Zones resource provides operations to manage consumption-domain zones.

This resource was added in vSphere API 8.0.0.1.

The Vcenter ConsumptionDomains Zones Cluster Associations resource provides operations to manage associations of a single consumption-domain zone to multiple vSphere clusters.

This resource was added in vSphere API 8.0.0.1.

The Vcenter CryptoManager Hosts Kms Providers resource provides operations to retrieve providers on a host.

This resource was added in vSphere API 7.0.2.0.

The Vcenter CryptoManager Kms Providers resource provides operations to create, retrieve, update, delete, export and import providers.

This resource was added in vSphere API 7.0.2.0.

The Vcenter Datacenter resource provides operations to manage datacenters in the vCenter Server.

The Datastore resource provides operations for manipulating a datastore.

The Vcenter Datastore DefaultPolicy resource provides operations related to storage policies associated with datastore object. The GET /vcenter/datastore/{datastore}/default-policy operation provides information about the default storage policy associated with the specific datastore.

This resource was added in vSphere API 6.7.

The Vcenter Deployment resource provides operations to get the status of the vCenter appliance deployment.

This resource was added in vSphere API 6.7.

The Vcenter Deployment ImportHistory resource provides operations for managing the import of vCenter historical data, e.g. Tasks, Events and Statistics, when is is imported separately from the upgrade.

This resource was added in vSphere API 6.7.

The Vcenter Deployment Install resource provides operations to configure the installation of the appliance

This resource was added in vSphere API 6.7.

This resource is deprecated as of vSphere API 9.0.0.0.

The Vcenter Deployment Install InitialConfig RemotePsc Thumbprint resource provides operations to get the thumbprint of the remote PSC.

This resource was added in vSphere API 6.7.

The Vcenter Deployment Install Psc Replicated resource provides operations to check if the configuring vCenter Server can be replicated to the remote PSC.

This resource was added in vSphere API 6.7.

The Vcenter Deployment Install Psc Standalone resource provides operations to check if the values provided for the standalone PSC satisfies the requirements.

This resource was added in vSphere API 6.7.

The Vcenter Deployment Install RemotePsc resource provides operations to check if the deployed vCenter Server can register with the remote PSC.

This resource was added in vSphere API 6.7.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vCenter Migration Assistant.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter Deployment Migrate resource provides operations to configure the migration of this appliance from an existing vCenter for Windows.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vCenter Migration Assistant.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter Deployment Migrate ActiveDirectory resource provides operations to check if the migrated vCenter Server appliance can join to the given domain using the provided credentials.

This resource was added in vSphere API 7.0.0.0.

The Vcenter Deployment Question resource provides operations to get the question raised during deployment and to answer them.

This resource was added in vSphere API 6.7.

This resource is deprecated as of vSphere API 9.0.0.0. Deprecated since the Reduced Downtime Upgrade (RDU) will be used for upgrading vCenter Server. The RDU endpoint for vCenter Server upgrade is the following vcenter/lcm/deployment/migration-upgrade.

The Vcenter Deployment Upgrade resource provides operations to configure the upgrade of this appliance from an existing vCenter appliance.

This resource was added in vSphere API 6.7.

The Vcenter EnvironmentBrowser ConfigOptionDescriptors resource provides access to the keys used to query for available configuration options on certain hardware via the GET /vcenter/environment-browser/config-option-descriptors operation.

This resource was added in vSphere API 8.0.2.00300.

The Vcenter EnvironmentBrowser ConfigOptions resource provides access to virtual machine configuration options. The GET /vcenter/environment-browser/config-options provides the keys for various config options available on certain hardware. Further the results of GET /vcenter/environment-browser/config-options describe the supported execution environment for a virtual machine on a particular set of hardware.

This resource was added in vSphere API 8.0.2.00300.

The Vcenter EnvironmentBrowser ConfigTargets resource allows one to enumerate the hardware capabilities / device backings for particular set of clusters.

This resource was added in vSphere API 8.0.2.00300.

The Vcenter EvcModes interface provides operations to work with custom EVC (Enhanced vMotion Compatibility) modes.

This resource was added in vSphere API 9.0.0.0.

The Folder resource provides operations for manipulating a vCenter Server folder.

The Vcenter FoundationLoadBalancers resource provides operations to manage load balancers(load balancer means foundation load balancer, the same term "load balancer" below has the same meaning) from vCenter Server.

This resource was added in vSphere API 9.0.0.0.

The Vcenter FoundationLoadBalancers Nodes resource provides operations to manager load balancer node(s).

This resource was added in vSphere API 9.0.0.0.

The Vcenter Guest CustomizationSpecs resource provides operations to manage guest customization specifications in the vCenter Server.

This resource was added in vSphere API 6.7.1.

The Vcenter Host resource provides operations to manage hosts in the vCenter Server.

The Vcenter Host Entropy ExternalPool resource provides operations to send entropy data and query external entropy pool information on an ESX host. Clients can check the entropy level of an ESX host using the GET /vcenter/host/{host}/entropy/external-pool operation to check Vcenter Host Entropy ExternalPool Info. When the entropy level has dropped below a threshold, a client can use the POST /vcenter/host/{host}/entropy/external-pool?action=add operation to add additional entropy until as required.

This resource was added in vSphere API 8.0.1.0.

The Vcenter Identity Broker Tenants AdminClient interface provides operations to read the token info of tenant admin client. The tenant client belongs to the pre-configured tenant(s), that were created at bootstrap of vcenter trustmanagement service. The tenant admin client tokens can be used to perform API invocations within a tenant entity.

This resource was added in vSphere API 8.0.1.0.

The Vcenter Identity Broker Tenants OperatorClient interface provides operations to read the token info of operator client. The operator client belongs to the pre-configured HWS tenant, that was created at bootstrap/installation of broker. The operator client tokens can be used to call the tenant management APIs like create, get and delete of tenant entity.

This resource was added in vSphere API 8.0.1.0.

The Vcenter Identity Providers interface provides operations to list, read and modify vCenter Server identity providers.

This resource was added in vSphere API 7.0.0.0.

The Network resource provides operations for manipulating a vCenter Server network.

The Vcenter Network Projects resource provides operations to manage projects in vCenter.

This resource was added in vSphere API 9.0.0.0.

The Vcenter Network Projects Vpcs resource provides operations to manage VPC(Virtual Private Cloud) in vCenter.

This resource was added in vSphere API 9.0.0.0.

The Vcenter Network Projects Vpcs Subnets resource provides operations to manage subnets in vCenter.

This resource was added in vSphere API 9.0.0.0.

The Ovfs resource provides operations for deploying Virtual Machines or Virtual Appliances.

This resource was added in vSphere API 9.0.0.0.

The ResourcePool resource provides operations for manipulating a vCenter Server resource pool.

This resource does not include virtual appliances in the inventory of resource pools even though part of the behavior of a virtual appliance is to act like a resource pool.

The Vcenter Services Service resource provides operations to manage a single/set of vCenter Server services.

This resource was added in vSphere API 6.7.

The Vcenter Storage Policies resource provides operations for managing the storage policies.

This resource was added in vSphere API 6.7.

The Compliance resource provides operations related to all the associated entities of given compliance statuses.

This resource was added in vSphere API 6.7.

The Vcenter Storage Policies Compliance VM schema provides operations related to query virtual machines of given compliance statuses.

This resource was added in vSphere API 6.7.

The Vcenter Storage Policies VM resource provides operations managing the storage policy association for a virtual machine and its virtual disks.

This resource was added in vSphere API 6.7.

The Vcenter System resource contains operations for negotiating API communication parameters including release ID.

Software developers obtain a list of supported API release IDs from vCenter documentation or as part of the client library (SDK) they work with at the time they develop and test a solution. The software solution initiates a handshake by sending a prioritized list of release IDs supported by the solution. The server selects the first release ID it supports from the list.

Negotiating API release ID is necessary to use APIs utilizing inheritance based polymorphism. These include all VI/JSON APIs and a set of vSphere Automation APIs. vSphere Automation APIs that require API release ID state this in their documentation. Consult the Programming Guide and API reference documentation of specific operations for more information.

This resource was added in vSphere API 8.0.2.0.

The Vcenter SystemConfig DeploymentType resource provides operations to get/set the type of the appliance.

This resource was added in vSphere API 6.7.

The Vcenter SystemConfig PscRegistration resource provides operations to get and set the PSC_EXTERNAL appliance a VCSA_EXTERNAL appliance is registered with.

This resource was added in vSphere API 6.7.

The Vcenter Tagging Associations resource provides operations to list tag associations.

This resource was added in vSphere API 7.0.0.0.

The Vcenter Tagging Categories resource provides functionality to list categories.

This resource was added in vSphere API 9.0.0.0.

The @name Tags @term service provides functionality to list tags.

This resource was added in vSphere API 9.0.0.0.

The Vcenter Topology Nodes interface provides operations to retrieve vCenter and Platform Services Controller nodes information in the topology.

This resource was added in vSphere API 6.7.2.

The Vcenter Topology ReplicationStatus interface provides operations to retrieve replication status information of vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see Vcenter Topology Nodes Info.type).

This resource was added in vSphere API 6.7.2.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure Attestation Services resource contains information about the registered instances of the Attestation Service in vCenter.

This resource was added in vSphere API 7.0.0.0.

The Vcenter TrustedInfrastructure Hosts Hardware Tpm interface provides operations to get available Trusted Platform Module (TPM) information on a host.

This resource was added in vSphere API 8.0.0.1.

The Vcenter TrustedInfrastructure Hosts Hardware Tpm EndorsementKeys interface provides operations to get the Trusted Platform Module (TPM) Endorsement Key (EK) on a host.

This resource was added in vSphere API 8.0.0.1.

The Vcenter TrustedInfrastructure Hosts Hardware Tpm EventLog interface provides operations to get the Trusted Platform Module (TPM) event log on a host.

This resource was added in vSphere API 8.0.0.1.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure Kms Services resource contains information about the registered instances of the Key Provider Service in vCenter.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure Principal resource contains information about the certificates which sign the tokens used by vCenter for authentication.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters resource manages all the Trust Authority Components on each Trust Authority Host in the cluster. The Vcenter TrustedInfrastructure TrustAuthorityClusters resource transforms a ClusterComputeResource into Trust Authority Cluster and vice versa.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters Attestation Os Esx BaseImages resource provides operations to manage trusted instances of ESX software on a cluster level.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters Attestation ServiceStatus resource provides operations to get the Attestation Service health status.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters Attestation Tpm2 CaCertificates resource provides operations to manage Trusted Platform Module (TPM) CA certificates.

Endorsement Keys are typically packaged in a certificate that is signed by a certificate authority (CA). This resource allows the CA certificate to be registered with the Attestation Service in order to validate TPM EK certificates when presented at attestation time.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters Attestation Tpm2 EndorsementKeys resource provides operations to manage Trusted Platform Module (TPM) Endorsement Keys (EK) on a cluster level.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters Attestation Tpm2 Settings interface provides operations to get or update settings related to the TPM 2.0 attestation protocol behavior.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters ConsumerPrincipals resource configures the token policies and STS trust necessary for the workload vCenter to query the trusted services for their status.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters Kms Providers interface provides operations to create, update and delete Key Providers that handoff to key servers.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters Kms Providers ClientCertificate interface provides operations to add and retrieve client certificate.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters Kms Providers ClientCertificate Csr interface provides operations to create a certificate signing request(CSR).

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters Kms Providers Credential interface provides operations to add a credential for external key management service(s).

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

Retrieves the list of TLS certificates used by peer key servers. Those are meant for review. Following approval these certificates should be added as trusted certificates in the Vcenter TrustedInfrastructure TrustAuthorityClusters Kms Providers TrustedPeerCertificates resource

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

Provides management operations for the TLS certificates trusted for communication with peer key servers.

To obtain the currently used TLS certificates use the Vcenter TrustedInfrastructure TrustAuthorityClusters Kms Providers CurrentPeerCertificates resource

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters Kms ServiceStatus resource provides operations to get the Key Provider Service health status.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityHosts Attestation resource contains information necessary to connect to the hosts running Attestation Service.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityHosts Kms resource contains information necessary to connect to the hosts running Key Provider Service.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustedClusters Attestation Services resource manages the Attestation Service instances a Trusted Cluster is configured to use.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustedClusters Attestation ServicesAppliedConfig resource provides information about the aggregate health of the applied Attestation Service configuration on the Trusted Clusters. The desired state of the Attestation Service is stored within vCenter, while the applied configuration is stored on the hosts in the cluster. The Vcenter TrustedInfrastructure TrustedClusters Attestation ServicesAppliedConfig resource is available for all clusters, not only Trusted Clusters. In such cases empty desired state is assumed, e.g. when an applied Attestation Service configuration is found outside of a Trusted Cluster it is considered an Vcenter TrustedInfrastructure TrustedClusters Attestation ServicesAppliedConfig Health.ERROR. The Vcenter TrustedInfrastructure TrustedClusters Attestation ServicesAppliedConfig resource is able to put the applied Attestation Service configuration into a consistent state when individual host configurations have diverged from the desired state.

This resource was added in vSphere API 7.0.1.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustedClusters Kms Services resource manages the Key Provider Service instances a Trusted Cluster is configured to use.

This resource was added in vSphere API 7.0.0.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustedClusters Kms ServicesAppliedConfig resource provides information about the aggregate health of the applied Key Provider Service configuration on the Trusted Clusters. The desired state of the Key Provider Service is stored within vCenter, while the applied configuration is stored on the hosts in the cluster. The Vcenter TrustedInfrastructure TrustedClusters Kms ServicesAppliedConfig resource is available for all clusters, not only Trusted Clusters. In such cases empty desired state is assumed, e.g. when an applied Key Provider Service configuration is found outside of a Trusted Cluster it is considered an Vcenter TrustedInfrastructure TrustedClusters Kms ServicesAppliedConfig Health.ERROR. The Vcenter TrustedInfrastructure TrustedClusters Kms ServicesAppliedConfig resource is able to put the applied Key Provider Service configuration into a consistent state when individual host configurations have diverged from the desired state.

This resource was added in vSphere API 7.0.1.0.

This resource is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0. Deprecated since the removal of vcenter trusted infrastructure.

API is disabled and returns errors as of vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustedClusters ServicesAppliedConfig resource provides information about the aggregate health of the applied Trust Authority Component configurations on the Trusted Clusters. The desired state of the Trust Authority Component configurations is stored within vCenter, while the applied configuration is stored on the hosts in the cluster and is a copy of the desired state. The Vcenter TrustedInfrastructure TrustedClusters ServicesAppliedConfig resource is available for all clusters, not only Trusted Clusters. When an applied Trust Authority Component configuration is found outside of a Trusted Cluster it is considered an Vcenter TrustedInfrastructure TrustedClusters ServicesAppliedConfig Health.ERROR. The Vcenter TrustedInfrastructure TrustedClusters ServicesAppliedConfig resource is able to make the applied Trust Authority Component configuration consistent with the desired state when individual host configurations have diverged from the desired state.

This resource was added in vSphere API 7.0.1.0.

The Vcenter Vcha Cluster resource provides operations to deploy and undeploy a vCenter High Availability (VCHA) cluster, failover from the active VCHA node to the passive VCHA node, and retrieve the status of the VCHA cluster.

This resource was added in vSphere API 6.7.1.

The Vcenter Vcha Cluster Active resource provides operations to get information related to the active vCenter High Availability (VCHA) node.

This resource was added in vSphere API 6.7.1.

The DeploymentType resource provides operations to get the deployment type of a vCenter High Availability Cluster (VCHA Cluster).

This resource was added in vSphere API 6.7.1.

The Mode resource provides operations to manage the operating mode of a vCenter High Availability Cluster (VCHA Cluster).

This resource was added in vSphere API 6.7.1.

The Vcenter Vcha Cluster Passive resource provides operations to validate a passive's placement configuration and redeploy the passive node in a vCenter High Availability (VCHA) cluster.

This resource was added in vSphere API 6.7.1.

The Vcenter Vcha Cluster Witness resource provides operations to validate a witness's placement configuration and redeploy the witness node in a vCenter High Availability (VCHA) cluster.

This resource was added in vSphere API 6.7.1.

The Vcenter Vcha Operations resource provides operations to figure out the currently active operations and currently disabled operations in a vCenter High Availability (VCHA) cluster.

This resource was added in vSphere API 6.7.1.

The Vcenter VM resource provides operations for managing the lifecycle of a virtual machine.

The Vcenter Vm Console Tickets resource provides operations for managing the virtual machine console tickets.

This resource was added in vSphere API 7.0.0.2.

The Vcenter Vm DataSets resource provides operations for sharing information between a virtual machine and its guest operating system.

See the VMware Guest SDK Programming Guide for details on using DataSets from within a virtual machine.

Information is grouped into data sets, each of which contains key-value entries comprising the data. It's expected that each application using the service will have at least one unique data set in which to store its data to avoid conflict with other applications. Each data set has attributes defining its access control and interoperability configuration.

It's not recommended that sensitive data (for example, passwords or private keys) be stored in plain-text. The data will be visible to other applications, running both on the management network and within the guest. The data can also be exposed by backups or templates.

Data set support requires the virtual machine be at virtual hardware version Vcenter Vm Hardware Version.VMX_20 or later.

Data sets should only be modified by the application that creates them. Otherwise the application may stop working.

This resource was added in vSphere API 8.0.0.0.

The Vcenter Vm DataSets Entries resource provides operations for manipulating individual entries in a data set.

This resource was added in vSphere API 8.0.0.0.

The Vcenter Vm EvcMode resource provides operations to manage the com.vmware.evc_mode.EvcMode settings of a virtual machine.

This resource was added in vSphere API 9.0.0.0.

The Vcenter Vm Guest Customization resource provides operations to apply a customization specification to a virtual machine in powered-off status.

This resource was added in vSphere API 7.0.0.0.

The Vcenter Vm Guest CustomizationLive resource provides operations to apply a customization specification to a virtual machine in powered-on status. If it needs to apply a customization specification to a powered-off virtual machine, please use Vcenter Vm Guest Customization.

Live customization only supports the Vcenter Guest ConfigurationSpec in RunSpec being configured as Vcenter Guest ConfigurationSpec.linux_config, also the Vcenter Guest LinuxConfiguration.script_text is not supported yet. If it needs to support other configurations please use Vcenter Vm Guest Customization.

Before using the Vcenter Vm Guest CustomizationLive resource, the Guest Customization Engine needs to be installed in the virtual machine. For the steps to install please see: Guest Customization Engine

This resource was added in vSphere API 9.0.0.0.

The Vcenter Vm Guest Environment resource provides operations to manage environment variables in the guest operating system.

This resource was added in vSphere API 7.0.2.0.

The Vcenter Vm Guest Filesystem Directories resource provides operations to manage directories in the guest filesystem.

This resource was added in vSphere API 7.0.2.0.

The Vcenter Vm Guest Filesystem Files resource provides operations to manage the files in the guest filesystem.

This resource was added in vSphere API 7.0.2.0.

The Vcenter Vm Guest Filesystem Transfers resource provides operations to copy files into and out of the guest file system.

This resource was added in vSphere API 7.0.2.0.

The Vcenter Vm Guest Identity resource provides operations for retrieving guest operating system identification information.

This resource was added in vSphere API 6.7.

The Vcenter Vm Guest LocalFilesystem resource provides operations for retrieving information about the guest operating system local file systems.

This resource was added in vSphere API 6.7.

The Vcenter Vm Guest Networking resource provides operations for retrieving guest operating system network information.

This resource was added in vSphere API 7.0.0.0.

The Vcenter Vm Guest Networking Interfaces resource provides operations for retrieving guest operating system network interface information.

This resource was added in vSphere API 7.0.0.0.

The Vcenter Vm Guest Networking Routes resource provides operations for retrieving guest operating system network routing information.

This resource was added in vSphere API 7.0.0.0.

Status of operations in the guest OS.

This resource was added in vSphere API 7.0.2.0.

The Vcenter Vm Guest Power resource provides operations for managing the guest operating system power state of a virtual machine.

This resource was added in vSphere API 6.7.

The Vcenter Vm Guest Processes resource provides operations to manage processes in the guest operating system.

This resource was added in vSphere API 7.0.2.0.

The Vcenter Vm Hardware resource provides operations for configuring the virtual hardware of a virtual machine.

The Vcenter Vm Hardware Adapter Nvme resource provides operations for configuring the virtual NVMe adapters of a virtual machine.

This resource was added in vSphere API 7.0.0.1.

The Vcenter Vm Hardware Adapter Sata resource provides operations for configuring the virtual SATA adapters of a virtual machine.

The Vcenter Vm Hardware Adapter Scsi resource provides operations for configuring the virtual SCSI adapters of a virtual machine.

The Vcenter Vm Hardware Boot resource provides operations for configuring the settings used when booting a virtual machine.

The Vcenter Vm Hardware Boot Device resource provides operations for configuring the device order used when booting a virtual machine.

The boot order may be specified using a mixture of device classes and device instances, chosen from among the following:

• Vcenter Vm Hardware Boot Device Type.CDROM: Boot from a virtual CD-ROM drive; the device instance(s) will be chosen by the BIOS subsystem.
• Vcenter Vm Hardware Boot Device Type.FLOPPY: Boot from a virtual floppy drive; the device instance(s) will be chosen by the BIOS subsystem.
• Vcenter Vm Hardware Boot Device Type.DISK: Boot from a virtual disk device; the device instance is specified explicitly in Vcenter Vm Hardware Boot Device Entry.disks list, and multiple instances may be specified in the list.
• Vcenter Vm Hardware Boot Device Type.ETHERNET: Boot from a virtual Ethernet adapter; the device instance is specified explicitly as Vcenter Vm Hardware Boot Device Entry.nic, and multiple adapters may be specified in the boot order list.

The Vcenter Vm Hardware Cdrom resource provides operations for configuring the virtual CD-ROM devices of a virtual machine.

The Vcenter Vm Hardware Cpu resource provides operations for configuring the CPU settings of a virtual machine.

The Vcenter Vm Hardware Disk resource provides operations for configuring the virtual disks of a virtual machine. A virtual disk has a backing such as a VMDK file. The backing has an independent lifecycle from the virtual machine when it is detached from the virtual machine. The POST /vcenter/vm/{vm}/hardware/disk operation provides the ability to create a new virtual disk. When creating a virtual disk, a new VMDK file may be created or an existing VMDK file may used as a backing. Once a VMDK file is associated with a virtual machine, its lifecycle will be bound to the virtual machine. In other words, it will be deleted when the virtual machine is deleted. The DELETE /vcenter/vm/{vm}/hardware/disk/{disk} operation provides the ability to detach a VMDK file from the virtual machine. The DELETE /vcenter/vm/{vm}/hardware/disk/{disk} operation does not delete the VMDK file that backs the virtual disk. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

The Vcenter Vm Hardware Ethernet resource provides operations for configuring the virtual Ethernet adapters of a virtual machine.

The Vcenter Vm Hardware Floppy resource provides operations for configuring the virtual floppy drives of a virtual machine.

The Vcenter Vm Hardware Memory resource provides operations for configuring the memory settings of a virtual machine.

The Vcenter Vm Hardware Parallel resource provides operations for configuring the virtual parallel ports of a virtual machine.

The Vcenter Vm Hardware Serial resource provides operations for configuring the virtual serial ports of a virtual machine.

The Vcenter Vm LibraryItem resource provides operations to identify virtual machines managed by Content Library.

This resource was added in vSphere API 6.9.1.

The Vcenter Vm Power resource provides operations for managing the power state of a virtual machine.

The Vcenter Vm Storage Policy resource provides operations to configure the storage policies associated with the virtual machine home and/or its virtual disks.

This resource was added in vSphere API 6.7.

The Compliance resource provides operations that return the compliance status of virtual machine entities(virtual machine home directory and virtual disks) that specify storage policy requirements.

This resource was added in vSphere API 6.7.

The Vcenter Vm Tools resource provides operations for managing VMware Tools in the guest operating system.

This resource was added in vSphere API 7.0.0.0.

The Vcenter Vm Tools Installer (@term service} provides operations to install VMware Tools in the guest operating system.

This resource was added in vSphere API 7.0.0.0.