Vcenter REST APIs Operations Index
All available Vcenter REST APIs Operations
Authentication
Authorization
Certificate Management Vcenter
Signing Certificate
GET
Get Certificate Management 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 Certificate Management 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 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.
Tls
GET
Get Certificate Management Tls
Returns the rhttpproxy TLS certificate. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
PUT
Set Certificate Management Tls
Replaces the rhttpproxy TLS certificate with the specified certificate. This operation can be used in three scenarios : 1. When the CSR is created and the private key is already stored, this operation can replace the certificate. The Tls.Spec.cert (but not Tls.Spec.key and Tls.Spec.root-cert) must be provided as input. 2. When the certificate is signed by a third party certificate authority/VMCA and the root certificate of the third party certificate authority/VMCA is already one of the trusted roots in the trust store, this operation can replace the certificate and private key. The Tls.Spec.cert and Tls.Spec.key (but not Tls.Spec.root-cert) must be provided as input. 3. When the certificate is signed by a third party certificate authority and the root certificate of the third party certificate authority is not one of the trusted roots in the trust store, this operation can replace the certificate, private key and root CA certificate. The Tls.Spec.cert,Tls.Spec.key and Tls.Spec.root-cert must be provided as input. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. The above three scenarios are only supported from vsphere 7.0 onwards. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Administer.
POST
Renew Tls
Renews the TLS certificate for the given duration period. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Administer.
POST
Replace Vmca Signed Tls
Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Administer.
Trusted Root Chains
POST
Create Certificate Management 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
List Certificate Management 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.
DELETE
Delete Chain Certificate Management 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.
GET
Get Chain Certificate Management 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.
Compute
Policies
POST
Create Compute Policies
Creates a new compute policy. if you do not have all of the privileges described as follows: - Operation execution requires ComputePolicy.Manage.
GET
List Compute 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.
DELETE
Delete Policy Compute Policies
Deletes a specific compute policy. if you do not have all of the privileges described as follows: - Operation execution requires ComputePolicy.Manage.
GET
Get Policy Compute 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.
Policies Capabilities
GET
Get Capability 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.
GET
List Compute 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.
Confidential Computing Sgx
Consumption Domains
Zones
POST
Create Consumption Domains 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
List Consumption Domains 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.
DELETE
Delete Zone Consumption Domains
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.
GET
Get Zone Consumption Domains
Returns the information about a specific zone. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
Zone Associations Cluster
GET
List Consumption Domains 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
POST
Add Zone Associations
Maps a consumption-domain zone to the specified vSphere clusters. If a cluster or a subset of specified clusters are already members of the specified zone, the result is success for those clusters. This operation supports partial success, i.e., it is possible that a subset of the specified clusters get successfully associated with the specified zone but the association fails for a subset of clusters. The returned result will contain the details about only those clusters for which the association failed. if you do not have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.
GET
Get Zone Cluster Associations
Returns identifiers of the clusters that are mapped to the specified consumption-domain zone. if you do not have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires System.Read.
POST
Remove Zone Associations
Removes the mapping between the specified consumption-domain zone and vSphere clusters. If a cluster or a subset of specified clusters are not members of the specified zone, then the result is a success for those clusters. In order to remove the mapping between a zone and a cluster, there must not be any workload running in that zone because removing the mapping between a zone and a cluster could result in undefined behavior for the entities depending on this mapping to be present. This operation supports partial success, i.e., it is possible that the mapping gets successfully removed for a subset of the clusters but fails for another subset of the clusters. The returned result will contain the details about only those clusters for which the operation failed. if you do not have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zone.Manage.
Content Registries
Harbor
POST
Create Content Registries Harbor
Creates a Harbor registry in the cluster.
GET
List Content Registries Harbor
Returns basic information of all Harbor registries.
DELETE
Delete Registry Registries Harbor
Delete the Harbor registry in the cluster. All Harbor projects, repositories and images will be deleted upon Harbor registry deletion.
GET
Get Registry Registries Harbor
Get detailed information of the Harbor registry.
Content Registries Harbor
Projects
POST
Create Registry Harbor Projects
Creates a project in a Harbor registry using the supplied specification. In vSphere 7.0, a Harbor registry is deployed in a vSphere cluster with vSphere namespaces enabled. When a namespace is created, a project with same name as the namespace is created in the Harbor registry, so this operation should not be called.
GET
List Registry Harbor Projects
Returns basic information of all projects in a Harbor registry.
DELETE
Delete Registry Project Harbor
Deletes the specified project from Harbor registry. Repositories and images in the project will be removed upon project deletion. Storage space of deleted images in the project will be reclaimed through next scheduled Harbor registry garbage collection. In vSphere 7.0, a Harbor registry is deployed in a vSphere cluster with vSphere namespaces enabled. When a namespace is deleted, a project with same name as the namespace is deleted from the Harbor registry, so this operation should not be called.
GET
Get Registry Project Harbor
Returns detailed information about the specified Harbor project.
POST
Purge Registry Project
Remove all repositories, images and members in the project. Storage space of deleted images in the project will be reclaimed through next scheduled Harbor registry garbage collection.
Crypto Manager Hosts Kms
Providers
GET
Get Host Provider Kms
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.
GET
List Host Crypto Manager 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.
Crypto Manager Kms
Providers
POST
Create Crypto Manager Kms Providers
Add a new provider. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ManageKeyServers.
GET
List Crypto Manager Kms Providers
Return a list of providers. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ReadKeyServersInfo.
DELETE
Delete Provider Kms
Remove a provider. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ManageKeyServers.
GET
Get Provider Kms
Return information about a provider. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ReadKeyServersInfo.
PATCH
Update Provider Kms
Update an existing 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 Kms Providers
Import provider configuration. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ManageKeyServers.
Datastore
Deployment
Import History
POST
Cancel Deployment History
Cancels the task for importing vCenter historical data.
GET
Get Deployment History
Get the current status of the vCenter historical data import.
POST
Pause Deployment History
Pauses the task for importing vCenter historical data.
POST
Resume Deployment History
Resumes the task for importing vCenter historical data.
POST
Start Deployment History
Creates and starts task for importing vCenter historical data.
Install
POST
Cancel Deployment Install
Cancel the appliance installation that is in progress.
POST
Check Deployment Install
Run sanity checks using the InstallSpec parameters passed.
GET
Get Deployment Install
Get the parameters used to configure the ongoing appliance installation.
POST
Start Deployment Install
Start the appliance installation.
Migrate
POST
Cancel Deployment Migrate
Cancel the appliance migration that is in progress.
POST
Check Deployment Migrate
Run sanity checks using the MigrateSpec parameters passed.
GET
Get Deployment Migrate
Get the MigrateSpec parameters used to configure the ongoing appliance migration.
POST
Start Deployment Migrate
Start the appliance migration.
Question
POST
Answer Deployment Question
Supply answer to the raised question.
GET
Get Deployment Question
Get the question that was raised during the configuration.
Upgrade
POST
Cancel Deployment Upgrade
Cancel the appliance upgrade that is in progress.
POST
Check Deployment Upgrade
Run sanity checks using the UpgradeSpec parameters passed.
GET
Get Deployment Upgrade
Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
POST
Start Deployment 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 Initial Config Remote Psc Thumbprint
Gets the SHA1 thumbprint of the remote PSC.
Install Psc Replicated
POST
Check Psc Replicated
Checks whether the provided remote PSC is reachable and can be replicated.
Guest
Customization Specs
POST
Create Guest Customization Specs
Creates a customization specification. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ModifyCustSpecs.
GET
List Guest Customization Specs
Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ReadCustSpecs.
DELETE
Delete Name Guest Customization Specs
Deletes a customization specification with the specified identifier. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ModifyCustSpecs.
GET
Get Name Guest Customization Specs
Returns the guest customization specification from vCenter with the specified identifier. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ReadCustSpecs.
PUT
Set Name Guest Customization Specs
Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.get) and editing it. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ModifyCustSpecs.
POST
Export Name Customization Specs
Returns the content of the customization specification in the specified format. Note that any passwords in the customization specification will be set to blank values during the export operation. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ReadCustSpecs.
POST
Import Guest Customization Specs
Converts a well formatted string to a CustomizationSpecs.CreateSpec. The resulting object can be passed to CustomizationSpecs.create operation. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ModifyCustSpecs.
Host Entropy
External Pool
POST
Add Host 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.
GET
Get Host 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.
Hvc
Links
POST
Create Hvc Links
Creates a new hybrid link between the local and foreign PSC. Usage beyond VMware Cloud on AWS is not supported.
GET
List Hvc Links
Enumerates the list of registered hybrid links. Usage beyond VMware Cloud on AWS is not supported.
DELETE
Delete Link Hvc
Deletes an existing hybrid link. This API should be used when unlink is initiated from Cloud Gateway.
GET
Get Link Hvc
Gets information for a link. Usage beyond VMware Cloud on AWS is not supported.
POST
Delete Link
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
POST
Add Management Administrators
Add the local sso group with the new group. Usage beyond VMware Cloud on AWS is not supported.
GET
Get Hvc 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 Hvc Management Administrators
Sets the groups in the local sso 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
POST
Create Identity 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
List Identity 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.
DELETE
Delete Provider Identity
Delete a vCenter Server identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.
GET
Get Provider Identity
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 Provider Identity
Update a vCenter Server identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.
Inventory
Iso
Image
POST
Mount Iso 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 Iso 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
Discovery Associated Products
POST
Create Lcm Discovery Associated Products
Associates a VMware product with vCenter Server manually. The product must be taken from the product catalog API.
GET
List Lcm Discovery Associated Products
Retrieves a list of all associated VMware product deployments with vCenter Server in the environment. The list contains both product deployments discovered automatically and deployments registered manually through the API.
DELETE
Delete Product Discovery Associated Products
Deletes or dissociates a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be deleted or dissociated.
GET
Get Product Discovery Associated Products
Returns the detailed information of a product associated with vCenter Server.
PATCH
Update Product Discovery Associated Products
Modifies a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be modified.
Discovery Product Catalog
GET
List Lcm Discovery Product Catalog
Retrieves a list of all VMware products that can be associated with vCenter Server.
Namespace Management
NSX Tier0 Gateway
GET
List Namespace Management Nsx Tier0 Gateways
Returns information of NSX-T Tier0 Gateways associated with a Distributed Switch.
Cluster Available Versions
GET
List Namespace Management Software Cluster Available Versions
Get information about each available upgrade.
Cluster Compatibility
GET
List Namespace Management 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
Get Namespace Management Cluster Compatibility V2
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 Namespace Management Cluster Size Info
Get information about the default values associated with various sizes.
Clusters
POST
Disable Cluster
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 Cluster
Enable vSphere Namespaces on the cluster. This operation sets up Kubernetes instance for the cluster along with worker nodes.
GET
Get Cluster Namespace Management
Returns information about a specific cluster.
PUT
Set Cluster Namespace Management
Set a new configuration on the cluster object. The specified configuration is applied in entirety and will replace the current configuration fully.
PATCH
Update Cluster Namespace Management
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
List Namespace Management Clusters
Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.
POST
Rotate Password Cluster
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 Namespace Management 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 Namespace Management Edge Cluster Compatibility
Returns Namespaces compatibility information of NSX-T Edge Clusters matching the EdgeClusterCompatibility.FilterSpec.
Hosts Config
GET
Get Namespace Management Capability
Returns support and licensing information about hosts under a VC.
Load Balancers
GET
Get Cluster Id Namespace Management Load Balancers
Returns information LoadBalancers.Info about the load balancer associated with the given cluster.
PUT
Set Cluster Id Namespace Management Load Balancers
Applies the entire load balancer spec to an existing load balancer configuration.
PATCH
Update Cluster Id Namespace Management 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.
GET
List Cluster Namespace Management Load Balancers
Returns information about all load balancers associated with the given cluster.
Namespace Resource Options
GET
Get Cluster Namespace Management Workload 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
POST
Create Cluster Namespace Management Networks
Create a vSphere Namespaces network object associated with the given cluster.
GET
List Cluster Namespace Management Networks
Return information about all vSphere Namespaces networks in the cluster.
DELETE
Delete Cluster Network Namespace Management
Delete the vSphere Namespaces object in the cluster.
GET
Get Cluster Network Namespace Management
Return information about a specific vSphere Namespaces network.
PUT
Set Cluster Network Namespace Management
Set a new configuration for the vSphere Namespaces network object associated with the given cluster.
PATCH
Update Cluster Network Namespace Management
Update the configuration of the vSphere Namespaces network object associated with the given cluster.
Supervisor Services
PATCH
Update Supervisor Service
Activate a Supervisor Service. This operation will change the SupervisorServices.State of the supervisor service to in ACTIVATED state, and activate all versions of the supervisor service.
POST
Check Content Namespace Management Supervisor Services
Perform validation checks on the content of a Supervisor Service version defined in the spec. The operation returns the validation status and relevant Supervisor Service version information that are available in the content. A custom format will always return a VALID status. Only vSphere and Carvel packages can return multiple validation statuses.
POST
Create Namespace Management Supervisor Services
Create a Supervisor Service. If version specs are provided in the spec, new Supervisor Service versions will be created as part of the operation.
GET
List Namespace Management Supervisor Services
Return the information about all Supervisor Services on this vCenter.
PATCH
Update Supervisor Service
Deactivate a Supervisor Service. This operation will change the SupervisorServices.State of the supervisor service to DEACTIVATED state, and deactivate all versions of the supervisor service. Note that this operation should be called before deleting the Supervisor Service.
DELETE
Delete Supervisor Service Namespace Management
Delete a Supervisor Service. This operation only deletes the Supervisor Service from vCenter if the Supervisor Service is in DEACTIVATED state, and all versions of the Supervisor Service are removed from vCenter. Note that the SupervisorServices.deactivate operation should be called to deactivate the Supervisor Service before the Supervisor Service can be deleted.
GET
Get Supervisor Service Namespace Management
Return the information for the specified Supervisor Service.
PATCH
Update Supervisor Service Namespace Management
Update a Supervisor Service.
Supervisors
POST
Enable On Compute Cluster 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 Namespace Management 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.
Virtual Machine Classes
POST
Create Namespace Management Virtual Machine Classes
Create a VM class object.
GET
List Namespace Management Virtual Machine Classes
Return information about all VirtualMachine classes.
DELETE
Delete Vm Class Namespace Management Virtual Machine Classes
Delete the VM class object.
GET
Get Vm Class Namespace Management Virtual Machine Classes
Return information about a VM class.
PATCH
Update Vm Class Namespace Management Virtual Machine Classes
Update the configuration of the VM class object
Networks Nsx Distributed Switches
GET
List Networks Nsx Distributed Switches
Returns basic information of the Distributed Switches matching the DistributedSwitches.FilterSpec.
Networks Nsx Distributed Switches Compatibility
POST
Check Compatibility Nsx Distributed Switches
Returns a list of Distributed Switches matching the given filter and their compatibility information.
Networks Nsx Edges Compatibility
POST
Check Compatibility Nsx Edges
Returns a list of Edges matching the given filter and their compatibility information.
Software Clusters
GET
Get Cluster Namespace Management Software
Returns upgrade related information of a specific cluster.
GET
List Namespace Management Software Clusters
Returns upgrade related information about all WCP enabled clusters.
POST
Upgrade Cluster
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 Namespace Management Stats Time Series
Gather statistical values for a cluster, namespace, or pod.
Supervisor Services Cluster Supervisor Services
POST
Create Cluster Namespace Management Supervisor Services
Create a Supervisor Service on the specified vSphere Supervisor. This operation will apply the Supervisor Service version's service definition on the cluster. This operation is possible only when the Supervisor Service and Supervisor Service version are in the ACTIVATED state. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
GET
List Cluster Namespace Management Supervisor Services
Return the summaries about all Supervisor Services on the specified vSphere Supervisor. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
DELETE
Delete Cluster Supervisor Service Namespace Management
Delete a Supervisor Service on the specified vSphere Supervisor. This operation will remove the Supervisor Service with the specified identifier from the cluster, by removing the corresponding namespace and deleting the operator(s) associated with the Supervisor Service. Note that this operation doesn't deal with the application instances that are created by the associated operator(s), so existing application instances could be orphaned if users don't clean or migrate them. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
GET
Get Cluster Supervisor Service Namespace Management
Return information about the specific Supervisor Service on the specified vSphere Supervisor. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
PUT
Set Cluster Supervisor Service Namespace Management
Set a new configuration to the specified Supervisor Service on the specified vSphere Supervisor. This operation will apply the new Supervisor Service version's service definition to the existing Supervisor Service on the cluster. This operation requires that the specified Supervisor Service is already installed in the specified Supervisor. Note that this operation doesn't interfere with the application instances that are created by the associated operator(s). So users should make sure the new version is still compatible with the existing application instances. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
Supervisor Services Versions
PATCH
Update Supervisor Service Version
Activate a Supervisor Service version. This operation will change the Versions.State of the version to ACTIVATED state.
POST
Create Supervisor Service Namespace Management Versions
Create a Supervisor Service version based on the provided service definition information for the version.
GET
List Supervisor Service Namespace Management Versions
Return the information about all versions of the Supervisor Service.
PATCH
Update Supervisor Service Version
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.
DELETE
Delete Supervisor Service Version Namespace Management
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.
GET
Get Supervisor Service Version Namespace Management
Return the information for the specified Supervisor Service version.
Supervisors Conditions
GET
Get Supervisor Namespace Management Conditions
Get all conditions of a given Supervisor.
Supervisors Summary
GET
Get Supervisor Namespace Management Summary
Queries the current state of the specified Supervisor.
GET
List Namespace Management Supervisors Summaries
Queries the current state of all Supervisors. Optionally, apply the filter to Supervisors that match the criteria in the Summary.FilterSpec.
Supervisors Identity Providers
POST
Create Supervisor Namespace Management Identity Providers
Create a new identity provider to be used with a Supervisor. Currently, only a single identity provider can be created.
GET
List Supervisor Namespace Management Identity Providers
List the identity providers configured for a given Supervisor.
DELETE
Delete Supervisor Provider Identity
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.
GET
Get Supervisor Provider Identity
Returns information about an identity provider configured for a Supervisor.
PUT
Set Supervisor Provider Identity
Update the entire configuration for an existing identity provider used with a Supervisor.
PATCH
Update Supervisor Provider Identity
Update an existing identity provider used with a Supervisor.
Namespaces
Access
POST
Create Namespace Domain Subject Access
Set up access control for the subject on given domain on the namespace.
DELETE
Delete Namespace Domain Subject Access
Remove access control of the subject on given domain from the namespace.
GET
Get Namespace Domain Subject Access
Get the information about the access control of the subject on given domain on the namespace.
PUT
Set Namespace Domain Subject Access
Set new access control on the namespace for the subject on given domain.
Instances
POST
Create Namespaces Instances
Create a namespace object on a single vSphere cluster.
GET
List Namespaces Instances
Returns the information about all namespaces in this vCenter Server. The information is tied to a single vSphere cluster.
POST
Create Namespaces Instances V2
Create a namespace object on a Supervisor.
GET
Get Namespaces Instances V2
Returns the information about all namespaces in this vCenter Server. The information is tied to a Supervisor.
DELETE
Delete Namespace Instances
Delete the namespace object in the cluster.
GET
Get Namespace Instances
Returns information about a specific namespace on a single vSphere cluster.
PUT
Set Namespace Instances
Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.
PATCH
Update Namespace Instances
Update the namespace object. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.
GET
Get Namespace Instances V2
Returns information about a specific namespace on a Supervisor.
Namespace Self Service
POST
Activate Cluster Namespace Self Service
Activate Namespace Self Service on the cluster on which vSphere Namespaces enabled. This operation empowers Dev Users/Groups as self-service namespace users to create Supervisor Namespaces through kubectl create namespace command. activate requires the availability of one or more templates in the system. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
POST
Activate With Template Cluster Namespace Self Service
Activate Namespace Self Service on the cluster after configuring namespace template. This is another variant of activate except configures template before activation. The template configuration includes either creating a new template or updating the existing template, depending on the template's existence. Here is supported the flow of actions using the activateWithTemplate call: 1. Activate with the new template using activateWithTemplate call. 2. Deactivate using deactivate call. 3. Active with updating the existing template using activateWithTemplate. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
POST
Deactivate Cluster Namespace Self Service
Deactivate Namespace Self Service on the cluster on which vSphere Namespaces enabled. This operation reverses Dev Users/Group's self-service namespace capability on the cluster. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
GET
Get Cluster Namespaces Namespace Self Service
Returns information about Namespace Self Service of a specific cluster. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
GET
List Namespaces Namespace Self Service
Returns basic information about Namespace Self Service on all clusters on which vSphere Namespaces are enabled on this vCenter.
Namespace Templates
POST
Create Cluster Namespaces Namespace Templates
Creates a namespace template on a cluster on which vSphere Namespaces are enabled in this vCenter Server. This release supports creating a single namespace template, and the call fails if there is a request to make another one. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
GET
List Cluster Namespaces Namespace Templates
Returns information about all the namespace templates associated with a cluster on which vSphere Namespaces are enabled in this vCenter Server. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
POST
Create Supervisor Namespace Templates
Creates a namespace template on a Supervisor. This release supports creating a single namespace template, and the call fails if there is a request to make another one.
GET
Get Supervisor Namespace Templates
Returns information about all the namespace templates associated with a Supervisor.
GET
Get Cluster Template Namespace Templates Namespaces
Get the information about a namespace template on given cluster. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
PATCH
Update Cluster Template Namespace Templates Namespaces
Updates a namespace template associated with cluster on which vSphere Namespaces are enabled in this vCenter Server. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
GET
Get Supervisor Template Namespace Templates
Get the information about a namespace template on a Supervisor.
PATCH
Update Supervisor Template Namespace Templates
Updates a namespace template associated with a Supervisor. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.
Ovf
Library Item
POST
Create Ovf Library Item
Creates a library item in content library from a virtual machine or virtual appliance. This operation creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this operation, the original content is overwritten. Meta data such as name and description is not updated for the exisitng library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource VirtualMachine or VirtualApp referenced by the attribute LibraryItem.DeployableIdentity.id requires VApp.Export. - The resource com.vmware.content.Library referenced by the attribute LibraryItem.CreateTarget.library-id requires ContentLibrary.AddLibraryItem. - The resource com.vmware.content.library.Item referenced by the attribute LibraryItem.CreateTarget.library-item-id requires System.Read.
POST
Deploy Ovf Library Item Id
Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance. This operation deploys an OVF package which is stored in the library item specified by ovfLibraryItemId. It uses the deployment specification in deploymentSpec to deploy the OVF package to the location specified by target. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter ovfLibraryItemId requires System.Read. - The resource HostSystem referenced by the attribute LibraryItem.DeploymentTarget.host-id requires System.Read. - The resource Network referenced by the map value of attribute LibraryItem.ResourcePoolDeploymentSpec.network-mappings requires System.Read. - The resource StorageProfile referenced by the attribute LibraryItem.ResourcePoolDeploymentSpec.storage-profile-id requires System.Read. - The resource Datastore referenced by the attribute LibraryItem.ResourcePoolDeploymentSpec.default-datastore-id requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItem.DeploymentTarget.resource-pool-id requires VApp.Import. - The resource Folder referenced by the attribute LibraryItem.DeploymentTarget.folder-id requires VApp.Import.
POST
Filter Ovf Library Item Id
Queries an OVF package stored in content library to retrieve information to use when deploying the package. See LibraryItem.deploy. This operation retrieves information from the descriptor of the OVF package stored in the library item specified by ovfLibraryItemId. The information returned by the operation can be used to populate the deployment specification (see LibraryItem.ResourcePoolDeploymentSpec when deploying the OVF package to the deployment target specified by target. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter ovfLibraryItemId requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItem.DeploymentTarget.resource-pool-id requires System.Read. - The resource HostSystem referenced by the attribute LibraryItem.DeploymentTarget.host-id requires System.Read. - The resource Folder referenced by the attribute LibraryItem.DeploymentTarget.folder-id requires System.Read.
Services
Storage
Policies
POST
Check Compatibility Policy Policies
Returns datastore compatibility summary about a specific storage policy.
GET
List Storage 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.
System Config
Tagging
Tokenservice
Token Exchange
Topology
Nodes
GET
Get Node Topology
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.
GET
List Topology 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.
Trusted Infrastructure
Trust Authority Clusters
GET
Get Cluster Trusted Infrastructure 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.
GET
List Trusted Infrastructure 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.
PATCH
Update Cluster Async
Updates the state of a cluster.
Attestation Services
POST
Create Trusted Infrastructure 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.
DELETE
Delete Service Attestation
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.
GET
Get Service Attestation
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.
POST
Query 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
Get Host Tpm Hardware
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.
GET
List Host Trusted Infrastructure 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.
Hosts Hardware Tpm Endorsement Keys
GET
Get Host Tpm Key Hardware Endorsement Keys
Get the TPM endorsement key details on a host. The information returned is derived from executing the TPM2_ReadPublic command on the endorsement key object handle. Trusted Platform Module Library Part 3: Commands, Family "2.0", Level 00 Revision 01.59, November 8, 2019, Section 12.4 TPM2_ReadPublic if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.
GET
List Host Tpm Hardware Host Endorsement Keys
Return a list of configured endorsement keys on a host. if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.
POST
Unseal Host Tpm Key
Unseal a secret that is bound to an endorsement key. Provided with duplicate key data, load the key as a child of the specified endorsement key using the TPM2_Import command and then unseal the secret data using the TPM2_Unseal command. The duplicate key must include only outer wrapping; inner wrapping is not supported. The duplicate key cannot have a complex authorization policy (e.g. including command selection, locality, etc). Only PCR policy authorization is supported at this time. Trusted Platform Module Library Part 1: Architecture, Family "2.0", Level 00 Revision 01.59, November 8, 2019, Section 23.3 Duplication Trusted Platform Module Library Part 3: Commands, Family "2.0", Level 00 Revision 01.59, November 8, 2019, Section 13.3 TPM2_Import Trusted Platform Module Library Part 3: Commands, Family "2.0", Level 00 Revision 01.59, November 8, 2019, Section 12.7 TPM2_Unseal if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Host.Tpm.Unseal.
Hosts Hardware Tpm Event Log
GET
Get Host Tpm Hardware Host 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 Trusted Infrastructure 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.
DELETE
Delete Service Kms
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.
GET
Get Service Kms
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.
POST
Query 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
POST
Create Cluster Consumer Principals Async
Creates a profile with the specified connection information on all hosts from a Trust Authority Cluster.
DELETE
Delete Cluster Profile Consumer Principals Async
Removes the read-only policy configured on ESX for a specific principal.
GET
Get Cluster Profile Consumer Principals Async
Retrieve information for a specific profile.
POST
Query Cluster Consumer Principals Async
Lists all policies configured on a specific cluster.
Trust Authority Clusters Attestation Service Status
GET
Get Cluster Attestation Service Status Async
Return the Attestation service health in the given cluster.
Trust Authority Clusters Attestation Os Esx Base Images
DELETE
Delete Cluster Version Base Images Async
Remove a trusted ESX base image of each ESX in the cluster.
GET
Get Cluster Version Base Images Async
Get the trusted ESX base version details.
POST
Import From Imgdb Cluster Base Images Async
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
Get Cluster Base Images Async
Return a list of trusted ESX base images.
Trust Authority Clusters Attestation Tpm2 Ca Certificates
POST
Create Cluster Tpm2 Ca Certificates Async
Add a new TPM CA certificate on a cluster.
GET
Get Cluster Tpm2 Ca Certificates Async
Return a list of configured TPM CA certificates on a cluster.
DELETE
Delete Cluster Name Ca Certificates Async
Remove a TPM CA certificate on a cluster.
GET
Get Cluster Name Ca Certificates Async
Get the TPM CA certificate details on a cluster.
Trust Authority Clusters Attestation Tpm2 Endorsement Keys
POST
Create Cluster Tpm2 Endorsement Keys Async
Add a new TPM endorsement key on a cluster.
GET
Get Cluster Tpm2 Endorsement Keys Async
Return a list of configured TPM endorsement keys in a cluster.
DELETE
Delete Cluster Name Endorsement Keys Async
Remove a TPM endorsement key on a cluster.
GET
Get Cluster Name Endorsement Keys Async
Get the TPM endorsement key details on a cluster.
Trust Authority Clusters Attestation Tpm2 Settings
GET
Get Cluster Tpm2 Settings Async
Return the TPM 2.0 protocol settings.
PATCH
Update Cluster Tpm2 Settings Async
Set the TPM 2.0 protocol settings.
Trust Authority Clusters Kms Providers
POST
Create Cluster Kms Providers Async
Add a new Key Provider.
GET
Get Cluster Kms Providers Async
Return a list of summary of Key Providers.
DELETE
Delete Cluster Provider Async
Remove a Key Provider.
GET
Get Cluster Provider Async
Return information about a Key Provider.
PATCH
Update Cluster Provider Async
Update an existing Key Provider.
Trust Authority Clusters Kms Service Status
GET
Get Cluster Kms Service Status Async
Return the Key Provider Service health in the given cluster.
Trust Authority Clusters Kms Providers Client Certificate
POST
Create Cluster Provider Client Certificate Async
Generate a new self signed client certificate. Existing client certificate is overwritten. The key server will use this certificate to validate the client connection.
GET
Get Cluster Provider Client Certificate Async
Return the existing client certificate.
PATCH
Update Cluster Provider Client Certificate Async
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 Cluster Provider Credential Async
Set the key server credential.
Trust Authority Clusters Kms Providers Current Peer Certificates
GET
Get Cluster Provider Peer Certs Current Async
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 Cluster Provider Peer Certs Trusted Async
Return the list of trusted server certificates.
PATCH
Update Cluster Provider Peer Certs Trusted Async
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
POST
Create Cluster Provider Client Certificate Csr Async
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.
GET
Get Cluster Provider Client Certificate Csr Async
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.
Trust Authority Hosts Attestation
GET
Get Host Trusted Infrastructure 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.
POST
Create Trusted Infrastructure 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.
Trust Authority Hosts Kms
GET
Get Host Trusted Infrastructure 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
Query 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 Cluster Services Applied Config Async
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 Cluster Services Applied Config Async
Returns detailed information about the health of the applied Trust Authority Component configurations in the given cluster.
PATCH
Update Cluster Services Applied Config Async
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
POST
Create Cluster Attestation Services Async
Configures the cluster to use a the given registered Attestation Service.
DELETE
Delete Cluster Service Async
Removes the Attestation Service instance from the configuration of the given cluster.
GET
Get Cluster Service Attestation
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.
POST
Query Cluster 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.
Trusted Clusters Attestation Services Applied Config
DELETE
Delete Cluster Attestation Services Applied Config Async
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 Cluster Attestation Services Applied Config Async
Returns detailed information about the health of the specified Attestation Service configuration applied to the cluster with respect to the desired state.
PATCH
Update Cluster Attestation Services Applied Config Async
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.
POST
Query Cluster Attestation Services Applied Config Async
Returns basic information about the health of all Attestation Service configurations applied to the cluster with respect to the desired state.
Trusted Clusters Kms Services
POST
Create Cluster Kms Services Async
Configures the cluster to use a the given registered Key Provider Service.
DELETE
Delete Cluster Service Async
Removes the Key Provider Service instance from the configuration of the given cluster.
GET
Get Cluster Service Kms
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.
POST
Query Cluster 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.
Trusted Clusters Kms Services Applied Config
DELETE
Delete Cluster Kms Services Applied Config Async
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.
GET
Get Cluster Kms Services Applied Config Async
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 Cluster Kms Services Applied Config Async
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.
POST
Query Cluster Kms Services Applied Config Async
Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state.
Vcenter
VM
POST
Clone Vm
Creates a virtual machine from an existing virtual machine. if you do not have all of the privileges described as follows: - The resource Datastore referenced by the attribute VM.DiskCloneSpec.datastore requires Datastore.AllocateSpace. - The resource Datastore referenced by the attribute VM.ClonePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Folder referenced by the attribute VM.ClonePlacementSpec.folder requires VirtualMachine.Inventory.CreateFromExisting. - The resource ResourcePool referenced by the attribute VM.ClonePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource VirtualMachine referenced by the attribute VM.CloneSpec.source requires VirtualMachine.Provisioning.Clone.
POST
Clone Vm Async
Creates a virtual machine from an existing virtual machine. if you do not have all of the privileges described as follows: - The resource Datastore referenced by the attribute VM.DiskCloneSpec.datastore requires Datastore.AllocateSpace. - The resource Datastore referenced by the attribute VM.ClonePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Folder referenced by the attribute VM.ClonePlacementSpec.folder requires VirtualMachine.Inventory.CreateFromExisting. - The resource ResourcePool referenced by the attribute VM.ClonePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource VirtualMachine referenced by the attribute VM.CloneSpec.source requires VirtualMachine.Provisioning.Clone.
POST
Create Vm
Creates a virtual machine. if you do not have all of the privileges described as follows: - The resource Folder referenced by the attribute VM.InventoryPlacementSpec.folder requires VirtualMachine.Inventory.Create. - The resource ResourcePool referenced by the attribute VM.ComputePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource Datastore referenced by the attribute VM.StoragePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Network referenced by the attribute Ethernet.BackingSpec.network requires Network.Assign.
GET
List Vm
Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec.
DELETE
Delete Vm
Deletes a virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete.
GET
Get Vm
Returns information about a virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires System.Read.
POST
Instant Clone Vm
Create an instant clone of an existing virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the attribute VM.InstantCloneSpec.source requires VirtualMachine.Provisioning.Clone and VirtualMachine.Inventory.CreateFromExisting. - The resource Folder referenced by the attribute VM.InstantClonePlacementSpec.folder requires VirtualMachine.Interact.PowerOn. - The resource ResourcePool referenced by the attribute VM.InstantClonePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource Datastore referenced by the attribute VM.InstantClonePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Network referenced by the attribute Ethernet.BackingSpec.network requires Network.Assign.
POST
Register Vm
Creates a virtual machine from existing virtual machine files on storage. if you do not have all of the privileges described as follows: - The resource Datastore referenced by the attribute VM.RegisterSpec.datastore requires System.Read. - The resource Folder referenced by the attribute VM.InventoryPlacementSpec.folder requires VirtualMachine.Inventory.Register. - The resource ResourcePool referenced by the attribute VM.ComputePlacementSpec.resource-pool requires Resource.AssignVMToPool.
POST
Relocate Vm
Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate. - The resource ResourcePool referenced by the attribute VM.RelocatePlacementSpec.resource-pool requires Resource.AssignVMToPool.
POST
Relocate Vm Async
Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate. - The resource ResourcePool referenced by the attribute VM.RelocatePlacementSpec.resource-pool requires Resource.AssignVMToPool.
POST
Unregister Vm
Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage. All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Unregister.
Cluster
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.
GET
List Cluster
Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec.
Datacenter
POST
Create Datacenter
Create a new datacenter in the vCenter inventory
GET
List Datacenter
Returns information about at most 1000 visible (subject to permission checks) datacenters in vCenter matching the Datacenter.FilterSpec.
DELETE
Delete Datacenter
Delete an empty datacenter from the vCenter Server
GET
Get Datacenter
Retrieves information about the datacenter corresponding to datacenter.
Datastore
GET
Get Datastore
Retrieves information about the datastore indicated by datastore.
GET
List Datastore
Returns information about at most 2500 visible (subject to permission checks) datastores in vCenter matching the Datastore.FilterSpec.
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.
Host
POST
Connect Host
Connect to the host corresponding to host previously added to the vCenter server.
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.
GET
List Host
Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.
DELETE
Delete Host
Remove a standalone host from the vCenter Server.
POST
Disconnect Host
Disconnect the host corresponding to host from the vCenter server
Resource Pool
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
List Resource Pool
Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePool.FilterSpec.
DELETE
Delete Resource Pool
Deletes a resource pool.
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.
Vcha
Cluster
POST
Deploy Vcha Cluster Async
Prepares, clones, and configures a VCHA cluster.
POST
Failover Vcha Cluster Async
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 Vcha Cluster
Retrieves the status of a VCHA cluster.
POST
Undeploy Vcha Cluster Async
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 Vcha 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 Vcha Cluster Deployment Type
Retrieves the deployment type of a VCHA cluster.
Cluster Mode
GET
Get Vcha Cluster Mode
Retrieves the current mode of a VCHA cluster.
PUT
Set Cluster Mode Async
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.
Vm
Data Sets
POST
Create Vm 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
List Vm 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.
DELETE
Delete Vm Data Set
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.
GET
Get Vm Data Set
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 Vm Data Set
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.
Hardware
GET
Get Vm Hardware
Returns the virtual hardware settings of a virtual machine.
PATCH
Update Vm Hardware
Updates the virtual hardware settings of a virtual machine.
POST
Upgrade Vm Hardware
Upgrades the virtual machine to a newer virtual hardware version.
Identity
Library Item
GET
Get Vm Library Item
Returns the information about the library item associated with the virtual machine.
Power
GET
Get Vm 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 Vm 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 Vm 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 Vm 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 Vm 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 Vm Tools
Get the properties of VMware Tools.
PATCH
Update Vm Tools
Update the properties of VMware Tools.
POST
Upgrade Vm 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 Vm Policy Compute Policies
Returns information about the compliance of a virtual machine with a compute policy.
Data Sets Entries
DELETE
Delete Vm Data Set Key Vm 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.
GET
Get Vm Data Set Key Vm 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 Vm Data Set Key Vm 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.
GET
List Vm Data Set Vm 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.
Guest Customization
GET
Get Vm 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 Vm 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 Vm Name 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 Vm 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 Local Filesystem
GET
Get Vm Guest Local Filesystem
Returns details of the local file systems in the guest operating system.
Guest Networking
GET
Get Vm Guest Networking
Returns information about the network configuration in the guest operating system.
Guest Power
GET
Get Vm Guest Power
Returns information about the guest operating system power state.
POST
Reboot Vm 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 Vm 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 Vm Guest Power
Issues a request to the guest operating system asking it to perform a suspend operation.
Guest Processes
POST
Create Vm Guest Processes
Starts a program in the guest operating system. A process started this way can have its status queried with Processes.list or Processes.get. When the process completes, its exit code and end time will be available for 5 minutes after completion. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.
POST
Delete Vm Pid Processes
Terminates a process in the guest OS. On Posix guests, the process is sent a SIGTERM signal. If that doesn't terminate the process, a SIGKILL signal is sent. A process may still be running if it's stuck. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.
POST
Get Vm Pid Processes
Returns the status of a process running in the guest operating system, including those started by Processes.create that may have recently completed. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
POST
List Vm Guest Processes
List the processes running in the guest operating system, plus those started by Processes.create that have recently completed. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
Guest Filesystem Directories
POST
Create Vm Filesystem Directories
Creates a directory in the guest operating system. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Create Temporary Vm Filesystem Directories
Creates a temporary directory. Creates a new unique temporary directory for the user to use as needed. The guest operating system may clean up the directory after a guest specific amount of time if parentPath is not set, or the user can remove the directory when no longer needed. The new directory name will be created in a guest-specific format using prefix, a guest generated string and suffix in parentPath. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Delete Vm Filesystem Directories
Deletes a directory in the guest operating system. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Move Vm Filesystem Directories
Renames a directory in the guest. Renames the directory, or copies and deletes the old contents as required by the underlying filsystem. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
Guest Filesystem Files
POST
Create Temporary Vm Filesystem Files
Creates a temporary file. Creates a new unique temporary file for the user to use as needed. The user is responsible for removing it when it is no longer needed. The new file name will be created in a guest-specific format using prefix, a guest generated string and suffix in parentPath. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Delete Vm Path Files
Deletes a file in the guest operating system if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Get Vm Path Files
Returns information about a file or directory in the guest. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
POST
List Vm Filesystem Files
Returns information about files and directories in the guest. Files are returned in operating system-specific (inode) order. If the directory is modified between queries, missing or duplicate results can occur. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
POST
Move Vm Filesystem Files
Renames a file in the guest. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Update Vm Filesystem Files
Changes the file attributes of a specified file or directory inside the guest. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
Guest Networking Interfaces
GET
List Vm Guest Networking Interfaces
Returns information about the networking interfaces in the guest operating system.
Guest Networking Routes
GET
List Vm Guest Networking Routes
Returns information about network routing in the guest operating system.
Hardware Boot
GET
Get Vm Hardware Boot
Returns the boot-related settings of a virtual machine.
PATCH
Update Vm Hardware Boot
Updates the boot-related settings of a virtual machine.
Hardware Cdrom
POST
Connect Vm Cdrom
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
Create Vm Hardware Cdrom
Adds a virtual CD-ROM device to the virtual machine.
GET
List Vm Hardware Cdrom
Returns commonly used information about the virtual CD-ROM devices belonging to the virtual machine.
DELETE
Delete Vm Cdrom Hardware
Removes a virtual CD-ROM device from the virtual machine.
GET
Get Vm Cdrom Hardware
Returns information about a virtual CD-ROM device.
PATCH
Update Vm Cdrom Hardware
Updates the configuration of a virtual CD-ROM device.
POST
Disconnect Vm Cdrom
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 Vm Hardware Cpu
Returns the CPU-related settings of a virtual machine.
PATCH
Update Vm Hardware Cpu
Updates the CPU-related settings of a virtual machine.
Hardware Disk
POST
Create Vm 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
List Vm Hardware Disk
Returns commonly used information about the virtual disks belonging to the virtual machine.
DELETE
Delete Vm Disk Hardware
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.
GET
Get Vm Disk Hardware
Returns information about a virtual disk.
PATCH
Update Vm Disk Hardware
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.
Hardware Ethernet
POST
Connect Vm Nic 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
Create Vm Hardware Ethernet
Adds a virtual Ethernet adapter to the virtual machine.
GET
List Vm Hardware Ethernet
Returns commonly used information about the virtual Ethernet adapters belonging to the virtual machine.
DELETE
Delete Vm Nic Hardware Ethernet
Removes a virtual Ethernet adapter from the virtual machine.
GET
Get Vm Nic Hardware Ethernet
Returns information about a virtual Ethernet adapter.
PATCH
Update Vm Nic Hardware Ethernet
Updates the configuration of a virtual Ethernet adapter.
POST
Disconnect Vm Nic 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
POST
Connect Vm 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
Create Vm Hardware Floppy
Adds a virtual floppy drive to the virtual machine.
GET
List Vm Hardware Floppy
Returns commonly used information about the virtual floppy drives belonging to the virtual machine.
DELETE
Delete Vm Floppy Hardware
Removes a virtual floppy drive from the virtual machine.
GET
Get Vm Floppy Hardware
Returns information about a virtual floppy drive.
PATCH
Update Vm Floppy Hardware
Updates the configuration of a virtual floppy drive.
POST
Disconnect Vm 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 Vm Hardware Memory
Returns the memory-related settings of a virtual machine.
PATCH
Update Vm Hardware Memory
Updates the memory-related settings of a virtual machine.
Hardware Parallel
POST
Connect Vm Port 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
Create Vm Hardware Parallel
Adds a virtual parallel port to the virtual machine.
GET
List Vm Hardware Parallel
Returns commonly used information about the virtual parallel ports belonging to the virtual machine.
DELETE
Delete Vm Port Hardware Parallel
Removes a virtual parallel port from the virtual machine.
GET
Get Vm Port Hardware Parallel
Returns information about a virtual parallel port.
PATCH
Update Vm Port Hardware Parallel
Updates the configuration of a virtual parallel port.
POST
Disconnect Vm Port 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
POST
Connect Vm Port 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
Create Vm Hardware Serial
Adds a virtual serial port to the virtual machine.
GET
List Vm Hardware Serial
Returns commonly used information about the virtual serial ports belonging to the virtual machine.
DELETE
Delete Vm Port Hardware Serial
Removes a virtual serial port from the virtual machine.
GET
Get Vm Port Hardware Serial
Returns information about a virtual serial port.
PATCH
Update Vm Port Hardware Serial
Updates the configuration of a virtual serial port.
POST
Disconnect Vm Port 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
POST
Create Vm Hardware Adapter Nvme
Adds a virtual NVMe adapter to the virtual machine.
GET
List Vm Hardware Adapter Nvme
Returns commonly used information about the virtual NVMe adapters belonging to the virtual machine.
DELETE
Delete Vm Adapter Hardware Nvme
Removes a virtual NVMe adapter from the virtual machine.
GET
Get Vm Adapter Hardware Nvme
Returns information about a virtual NVMe adapter.
Hardware Adapter Sata
POST
Create Vm Hardware Adapter Sata
Adds a virtual SATA adapter to the virtual machine.
GET
List Vm Hardware Adapter Sata
Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.
DELETE
Delete Vm Adapter Hardware Sata
Removes a virtual SATA adapter from the virtual machine.
GET
Get Vm Adapter Hardware Sata
Returns information about a virtual SATA adapter.
Hardware Adapter Scsi
POST
Create Vm Hardware Adapter Scsi
Adds a virtual SCSI adapter to the virtual machine.
GET
List Vm Hardware Adapter Scsi
Returns commonly used information about the virtual SCSI adapters belonging to the virtual machine.
DELETE
Delete Vm Adapter Hardware Scsi
Removes a virtual SCSI adapter from the virtual machine.
GET
Get Vm Adapter Hardware Scsi
Returns information about a virtual SCSI adapter.
PATCH
Update Vm Adapter Hardware Scsi
Updates the configuration of a virtual SCSI adapter.
Hardware Boot Device
GET
Get Vm 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 Vm 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 Vm Storage Policy
Returns Information about Storage Policy associated with a virtual machine's home directory and/or its virtual hard disks.
PATCH
Update Vm Storage Policy
Updates the storage policy configuration of a virtual machine and/or its associated virtual hard disks.
Storage Policy Compliance
POST
Check Vm Policy Compliance
Returns the storage policy Compliance Compliance.Info of a virtual machine after explicitly re-computing compliance check.
GET
Get Vm Storage Policy Compliance
Returns the cached storage policy compliance information of a virtual machine.
Tools Installer
POST
Connect Vm 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 Vm Tools Installer
Disconnect the VMware Tools installer CD image.
GET
Get Vm Tools Installer
Get information about the VMware Tools installer.
Vm Template
Library Items
POST
Create Vm Template Library Items
Creates a library item in content library from a virtual machine. This operation creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.Library referenced by the attribute LibraryItems.CreateSpec.library requires ContentLibrary.AddLibraryItem. - The resource VirtualMachine referenced by the attribute LibraryItems.CreateSpec.source-vm requires System.Read. - The resource Datastore referenced by the attribute LibraryItems.CreateSpecVmHomeStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecVmHomeStoragePolicy.policy requires System.Read. - The resource Datastore referenced by the attribute LibraryItems.CreateSpecDiskStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecDiskStoragePolicy.policy requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.CreateSpec.disk-storage-overrides requires System.Read. - The resource Folder referenced by the attribute LibraryItems.CreatePlacementSpec.folder requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItems.CreatePlacementSpec.resource-pool requires System.Read. - The resource HostSystem referenced by the attribute LibraryItems.CreatePlacementSpec.host requires System.Read. - The resource ClusterComputeResource referenced by the attribute LibraryItems.CreatePlacementSpec.cluster requires System.Read.
POST
Deploy Template Library Item Library Items
Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem. It uses the deployment specification in spec. If LibraryItems.DeploySpec.powered-on and/or LibraryItems.DeploySpec.guest-customization are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires VirtualMachine.Provisioning.DeployTemplate. - The resource Datastore referenced by the attribute LibraryItems.DeploySpecVmHomeStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecVmHomeStoragePolicy.policy requires System.Read. - The resource Datastore referenced by the attribute LibraryItems.DeploySpecDiskStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecDiskStoragePolicy.policy requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.DeploySpec.disk-storage-overrides requires System.Read. - The resource Folder referenced by the attribute LibraryItems.DeployPlacementSpec.folder requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItems.DeployPlacementSpec.resource-pool requires System.Read. - The resource HostSystem referenced by the attribute LibraryItems.DeployPlacementSpec.host requires System.Read. - The resource ClusterComputeResource referenced by the attribute LibraryItems.DeployPlacementSpec.cluster requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.nics requires System.Read. - The resource Network referenced by the attribute LibraryItems.EthernetUpdateSpec.network requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the attribute LibraryItems.HardwareCustomizationSpec.disks-to-remove requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.disks-to-update requires System.Read.
GET
Get Template Library Item Vm Template
Returns information about a virtual machine template contained in the library item specified by templateLibraryItem if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
Library Items Check Outs
POST
Check In Template Library Item Vm Check Outs
Checks in a virtual machine into the library item. This operation updates the library item to contain the virtual machine being checked in as a template. This template becomes the latest version of the library item. The previous virtual machine template contained in the library item is available as a backup and its information can be queried using the Versions service. At most one previous version of a virtual machine template is retained in the library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckInTemplate. - The resource VirtualMachine referenced by the parameter vm requires System.Read.
POST
Check Out Template Library Item Check Outs
Checks out a library item containing a virtual machine template. This operation makes a copy of the source virtual machine template contained in the library item as a virtual machine. The virtual machine is copied with the same storage specification as the source virtual machine template. Changes to the checked out virtual machine do not affect the virtual machine template contained in the library item. To save these changes back into the library item, CheckOuts.check-in the virtual machine. To discard the changes, CheckOuts.delete the virtual machine. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckOutTemplate. - The resource Folder referenced by the attribute CheckOuts.PlacementSpec.folder requires System.Read. - The resource ResourcePool referenced by the attribute CheckOuts.PlacementSpec.resource-pool requires System.Read. - The resource HostSystem referenced by the attribute CheckOuts.PlacementSpec.host requires System.Read. - The resource ClusterComputeResource referenced by the attribute CheckOuts.PlacementSpec.cluster requires System.Read.
DELETE
Delete Template Library Item Vm Vm Template Check Outs
Deletes the checked out virtual machine. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
GET
Get Template Library Item Vm Vm Template Check Outs
Returns the information about a checked out virtual machine. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read. - The resource VirtualMachine referenced by the parameter vm requires System.Read.
GET
List Template Library Item Vm Template Check Outs
Returns commonly used information about the virtual machines that are checked out of the library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
Library Items Versions
DELETE
Delete Template Library Item Version Vm Template
Deletes the virtual machine template contained in the library item at the specified version. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.DeleteLibraryItem. - The resource com.vmware.content.library.item.Version referenced by the parameter version requires System.Read.
GET
Get Template Library Item Version Vm Template
Returns information about the live version of a library item containing a virtual machine template. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read. - The resource com.vmware.content.library.item.Version referenced by the parameter version requires System.Read.
GET
List Template Library Item Vm Template Versions
Returns commonly used information about the live versions of a virtual machine template library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
POST
Rollback Template Library Item Version
Rollbacks a library item containing a virtual machine template to a previous version. The virtual machine template at the specified version becomes the latest virtual machine template with a new version identifier. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckInTemplate. - The resource com.vmware.content.library.item.Version referenced by the parameter version requires System.Read.