Vcenter REST APIs Operations Index

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.

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.

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

Replace Vmca Signed Tls

Tls Csr

Create Certificate Management Tls Csr

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

Trusted Root Chains

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.

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

Vmca Root

Create Certificate Management Vmca Root

Replace Root Certificate with VMCA signed one using the given Spec. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Administer.

Compute

Policies

Policies Capabilities

Policies Tag Usage

Content Registries

Harbor

Create Content Registries Harbor

Creates a Harbor registry in the cluster.

List Content Registries Harbor

Returns basic information of all Harbor registries.

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 Registry Registries Harbor

Get detailed information of the Harbor registry.

Health

Get Registry Registries Health

Returns the health information of a container registry in the vCenter.

Content Registries Harbor

Projects

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.

List Registry Harbor Projects

Returns basic information of all projects in a Harbor registry.

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 Registry Project Harbor

Returns detailed information about the specified Harbor 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.

Purge Registry Project

Datastore

Default Policy

Get Datastore Default Policy

Returns the identifier of the current default storage policy associated with the specified datastore.

Deployment

Import History

Cancel Deployment History

Cancels the task for importing vCenter historical data.

Get the current status of the vCenter historical data import.

Get Deployment History

Pauses the task for importing vCenter historical data.

Pause Deployment History

Resume Deployment History

Resumes the task for importing vCenter historical data.

Creates and starts task for importing vCenter historical data.

Start Deployment History

Install

Cancel Deployment Install

Cancel the appliance installation that is in progress.

Run sanity checks using the InstallSpec parameters passed.

Check Deployment Install

Get the parameters used to configure the ongoing appliance installation.

Get Deployment Install

Start the appliance installation.

Start Deployment Install

Migrate

Cancel Deployment Migrate

Cancel the appliance migration that is in progress.

Run sanity checks using the MigrateSpec parameters passed.

Check Deployment Migrate

Get the MigrateSpec parameters used to configure the ongoing appliance migration.

Get Deployment Migrate

Start the appliance migration.

Start Deployment Migrate

Question

Answer Deployment Question

Supply answer to the raised question.

Get the question that was raised during the configuration.

Get Deployment Question

Upgrade

Cancel Deployment Upgrade

Cancel the appliance upgrade that is in progress.

Run sanity checks using the UpgradeSpec parameters passed.

Check Deployment Upgrade

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.

Get Deployment Upgrade

Start the appliance installation.

Start Deployment Upgrade

Install Remote Psc

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

Check Install Remote Psc

Install Initial Config Remote Psc Thumbprint

Get Initial Config Remote Psc Thumbprint

Gets the SHA1 thumbprint of the remote PSC.

Install Psc Replicated

Checks whether the provided remote PSC is reachable and can be replicated.

Check Psc Replicated

Install Psc Standalone

Checks that the information to configure a non-replicated PSC satisfies the requirements.

Check Psc Standalone

Migrate Active Directory

Check Migrate Active Directory

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

Guest

Customization Specs

Create Guest Customization Specs

Creates a customization specification.

List Guest Customization Specs

Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec.

Delete Name Guest Customization Specs

Deletes a customization specification with the specified identifier.

Get Name Guest Customization Specs

Returns the guest customization specification from vCenter with the specified identifier.

Create Name Guest Customization Specs

Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.get) and editing it.

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.

Import Guest Customization Specs

Converts a well formatted string to a CustomizationSpecs.CreateSpec. The resulting object can be passed to CustomizationSpecs.create operation.

Hvc

Links

Creates a new hybrid link between the local and foreign PSC. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Create Hvc Links

Enumerates the list of registered hybrid links. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

List Hvc Links

Deletes an existing hybrid link. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Delete Link Hvc

Links Sync

Resets the sync state between the linked domains by initiating a fresh sync for all providers. If an existing sync is in progress this cancels the sync. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Reset Link Sync

Links Sync Providers

Gets Sync information for a sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Get Link Provider Sync

List Link Hvc Sync Providers

Enumerates the sync providers. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Initiates synchronization between the local and remote replicas for the sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Start Link Provider

Management Administrators

Add Management Administrators

Add the local sso group with the new group. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Set Hvc Management Administrators

Sets the groups in the local sso group. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Remove Management Administrators

Remove the group from the local sso group. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Identity

Providers

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.

Retrieve all identity providers. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

List Identity Providers

Delete a vCenter Server identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.

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

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

Update Provider Identity

Inventory

Datastore

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

Find Inventory Datastore

Network

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

Find Inventory Network

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.

Mount Library Item

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.

Unmount Vm

Lcm

Reports

Discovery Associated Products

Discovery Interop Report

Discovery Product Catalog

Update Pending

Update Precheck Report

Namespace Management

Cluster Available Versions

Cluster Compatibility

Cluster Size Info

Clusters

Distributed Switch Compatibility

Edge Cluster Compatibility

Hosts Config

Load Balancers

Namespace Resource Options

Networks

Support Bundle

Software Clusters

Stats Time Series

Namespaces

Access

Instances

User Instances

Ovf

Export Flag

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

List Ovf Export Flag

Import Flag

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

List Ovf Import Flag

Library Item

Creates a library item in content library from a virtual machine or virtual appliance. This operation creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this operation, the original content is overwritten. Meta data such as name and description is not updated for the exisitng library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource null or null referenced by the attribute LibraryItem.DeployableIdentity.id requires VApp.Export. - The resource com.vmware.content.Library referenced by the attribute LibraryItem.CreateTarget.library-id requires ContentLibrary.AddLibraryItem. - The resource com.vmware.content.library.Item referenced by the attribute LibraryItem.CreateTarget.library-item-id requires System.Read.

Create Ovf Library Item

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.

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

Service

Returns the state of a service.

Get Service

Updates the properties of a service.

Update Service

Lists details of vCenter services.

Get Services

Create Service Restart

Storage

Policies

Check Compatibility Policy Policies

Returns datastore compatibility summary about a specific storage policy.

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.

List Storage Policies

Policies VM

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

List Policy Policies Vm

Policies Compliance

List Policies Entities Compliance

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

Policies Compliance VM

List Policies Compliance Vm

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

System Config

Deployment Type

Get System Config Deployment Type

Get the type of the vCenter appliance.

Create System Config Deployment Type

Reconfigure the type of the vCenter appliance.

Psc Registration

Get System Config Psc Registration

Get information of the PSC that this appliance is registered with.

Create System Config Psc Registration

Repoint this vCenter Server appliance to a different external PSC.

Tagging

Associations

Tokenservice

Token Exchange

Create Tokenservice Token Exchange

Exchanges incoming token based on the spec and current client authorization data.

Topology

Nodes

Retrieve details for a given identifier of the vCenter or Platform Services Controller node. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.

Get Node Topology

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.

List Topology Nodes

Replication Status

List Topology Replication Status

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

Trusted Infrastructure

Principal

Trust Authority Clusters

Attestation Services

Kms Services

Trust Authority Clusters Consumer Principals

Trust Authority Clusters Attestation Service Status

Trust Authority Clusters Attestation Os Esx Base Images

Trust Authority Clusters Attestation Tpm2 Ca Certificates

Trust Authority Clusters Attestation Tpm2 Endorsement Keys

Trust Authority Clusters Attestation Tpm2 Settings

Trust Authority Clusters Kms Providers

Trust Authority Clusters Kms Service Status

Trust Authority Clusters Kms Providers Client Certificate

Trust Authority Clusters Kms Providers Credential

Trust Authority Clusters Kms Providers Current Peer Certificates

Trust Authority Clusters Kms Providers Trusted Peer Certificates

Trust Authority Clusters Kms Providers Client Certificate Csr

Trust Authority Hosts Attestation

Trust Authority Hosts Kms

Trusted Clusters Services Applied Config

Trusted Clusters Attestation Services

Trusted Clusters Attestation Services Applied Config

Trusted Clusters Kms Services

Trusted Clusters Kms Services Applied Config

Vcenter

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.

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

Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec.

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

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

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

Instant Clone 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.

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.

Relocate 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

Retrieves information about the cluster corresponding to cluster.

Get Cluster

Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec.

List Cluster

Datacenter

Create a new datacenter in the vCenter inventory

Create Datacenter

Returns information about at most 1000 visible (subject to permission checks) datacenters in vCenter matching the Datacenter.FilterSpec.

List Datacenter

Delete an empty datacenter from the vCenter Server

Delete Datacenter

Retrieves information about the datacenter corresponding to datacenter.

Get Datacenter

Datastore

Retrieves information about the datastore indicated by datastore.

Get Datastore

Returns information about at most 2500 visible (subject to permission checks) datastores in vCenter matching the Datastore.FilterSpec.

List Datastore

Deployment

Get the current status of the appliance deployment.

Get Deployment

Rollback a failed appliance so it can be configured once again.

Rollback Deployment

Folder

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

List Folder

Host

Connect to the host corresponding to host previously added to the vCenter server.

Create Host Connect

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.

Create Host

Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.

List Host

Remove a standalone host from the vCenter Server.

Delete Host

Disconnect the host corresponding to host from the vCenter server

Create Host Disconnect

Network

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

List Network

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.

Create Resource Pool

Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePool.FilterSpec.

List Resource Pool

Delete Resource Pool

Deletes a 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.

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

Update Resource Pool

Vcha

Cluster

Deploy Vcha Cluster Async

Prepares, clones, and configures a VCHA cluster.

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.

Retrieves the status of a VCHA cluster.

Get Vcha Cluster

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

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

Get Vcha Operations

Cluster Active

Retrieves information about the active node of a VCHA cluster.

Get Cluster Active

Cluster Deployment Type

Get Vcha Cluster Deployment Type

Retrieves the deployment type of a VCHA cluster.

Cluster Mode

Retrieves the current mode of a VCHA cluster.

Get Vcha Cluster Mode

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.

Set Cluster Mode Async

Cluster Passive

Validates the specified passive node's placement configuration.

Check Cluster Passive

Redeploy Cluster Passive Async

Creates the passive node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.

Cluster Witness

Validates the specified witness node's placement configuration.

Check Cluster Witness

Redeploy Cluster Witness Async

Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.

Hardware

Returns the virtual hardware settings of a virtual machine.

Get Vm Hardware

Updates the virtual hardware settings of a virtual machine.

Update Vm Hardware

Create Vm Hardware Action Upgrade

Upgrades the virtual machine to a newer virtual hardware version.

Identity

Library Item

Returns the information about the library item associated with the virtual machine.

Get Vm Library Item

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.

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

Create Vm Power Reset

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.

Create Vm Power Start

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.

Create Vm Power Stop

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.

Create Vm Power Suspend

Tools

Get the properties of VMware Tools.

Get Vm Tools

Update the properties of VMware Tools.

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

Upgrade Vm Tools

Compute Policies

Console Tickets

Create Vm Console Tickets

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

Guest Customization

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.

Guest Identity

Return information about the guest.

Get Vm Guest Identity

Guest Local Filesystem

Get Vm Guest Local Filesystem

Returns details of the local file systems in the guest operating system.

Guest Networking

Returns information about the network configuration in the guest operating system.

Get Vm Guest Networking

Guest Power

Returns information about the guest operating system power state.

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

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

Shutdown Vm Guest Power

Issues a request to the guest operating system asking it to perform a suspend operation.

Standby Vm Guest Power

Guest Networking Interfaces

List Vm Guest Networking Interfaces

Returns information about the networking interfaces in the guest operating system.

Guest Networking Routes

List Vm Guest Networking Routes

Returns information about network routing in the guest operating system.

Hardware Boot

Returns the boot-related settings of a virtual machine.

Get Vm Hardware Boot

Updates the boot-related settings of a virtual machine.

Update Vm Hardware Boot

Hardware Cdrom

Create Vm Cdrom Hardware Connect

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.

Adds a virtual CD-ROM device to the virtual machine.

Create Vm Hardware Cdrom

Returns commonly used information about the virtual CD-ROM devices belonging to the virtual machine.

List Vm Hardware Cdrom

Removes a virtual CD-ROM device from the virtual machine.

Delete Vm Cdrom Hardware

Returns information about a virtual CD-ROM device.

Get Vm Cdrom Hardware

Updates the configuration of a virtual CD-ROM device.

Update Vm Cdrom Hardware

Create Vm Cdrom Hardware Disconnect

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

Returns the CPU-related settings of a virtual machine.

Get Vm Hardware Cpu

Updates the CPU-related settings of a virtual machine.

Update Vm Hardware Cpu

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.

Create Vm Hardware Disk

Returns commonly used information about the virtual disks belonging to the virtual machine.

List Vm Hardware Disk

Removes a virtual disk from the virtual machine. This operation does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

Delete Vm Disk Hardware

Returns information about a virtual disk.

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

Update Vm Disk Hardware

Hardware Ethernet

Create Vm Nic Ethernet Connect

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.

Create Vm Hardware Ethernet

Adds a virtual Ethernet adapter to the virtual machine.

List Vm Hardware Ethernet

Returns commonly used information about the virtual Ethernet adapters belonging to the virtual machine.

Delete Vm Nic Hardware Ethernet

Removes a virtual Ethernet adapter from the virtual machine.

Get Vm Nic Hardware Ethernet

Returns information about a virtual Ethernet adapter.

Update Vm Nic Hardware Ethernet

Updates the configuration of a virtual Ethernet adapter.

Create Vm Nic Ethernet Disconnect

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

Create Vm Floppy Hardware Connect

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.

Create Vm Hardware Floppy

Adds a virtual floppy drive to the virtual machine.

Returns commonly used information about the virtual floppy drives belonging to the virtual machine.

List Vm Hardware Floppy

Delete Vm Floppy Hardware

Removes a virtual floppy drive from the virtual machine.

Returns information about a virtual floppy drive.

Get Vm Floppy Hardware

Update Vm Floppy Hardware

Updates the configuration of a virtual floppy drive.

Create Vm Floppy Hardware Disconnect

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

Returns the memory-related settings of a virtual machine.

Get Vm Hardware Memory

Update Vm Hardware Memory

Updates the memory-related settings of a virtual machine.

Hardware Parallel

Create Vm Port Parallel Connect

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.

Create Vm Hardware Parallel

Adds a virtual parallel port to the virtual machine.

List Vm Hardware Parallel

Returns commonly used information about the virtual parallel ports belonging to the virtual machine.

Delete Vm Port Hardware Parallel

Removes a virtual parallel port from the virtual machine.

Get Vm Port Hardware Parallel

Returns information about a virtual parallel port.

Update Vm Port Hardware Parallel

Updates the configuration of a virtual parallel port.

Create Vm Port Parallel Disconnect

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

Create Vm Port Serial Connect

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.

Create Vm Hardware Serial

Adds a virtual serial port to the virtual machine.

Returns commonly used information about the virtual serial ports belonging to the virtual machine.

List Vm Hardware Serial

Delete Vm Port Hardware Serial

Removes a virtual serial port from the virtual machine.

Get Vm Port Hardware Serial

Returns information about a virtual serial port.

Update Vm Port Hardware Serial

Updates the configuration of a virtual serial port.

Create Vm Port Serial Disconnect

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 Sata

Create Vm Hardware Adapter Sata

Adds a virtual SATA adapter to the virtual machine.

List Vm Hardware Adapter Sata

Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.

Delete Vm Adapter Hardware Sata

Removes a virtual SATA adapter from the virtual machine.

Get Vm Adapter Hardware Sata

Returns information about a virtual SATA adapter.

Hardware Adapter Scsi

Create Vm Hardware Adapter Scsi

Adds a virtual SCSI adapter to the virtual machine.

List Vm Hardware Adapter Scsi

Returns commonly used information about the virtual SCSI adapters belonging to the virtual machine.

Delete Vm Adapter Hardware Scsi

Removes a virtual SCSI adapter from the virtual machine.

Get Vm Adapter Hardware Scsi

Returns information about a virtual SCSI adapter.

Update Vm Adapter Hardware Scsi

Updates the configuration of a virtual SCSI adapter.

Hardware Boot Device

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.

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

Returns Information about Storage Policy associated with a virtual machine's home directory and/or its virtual hard disks.

Get Vm Storage Policy

Updates the storage policy configuration of a virtual machine and/or its associated virtual hard disks.

Update Vm Storage Policy

Storage Policy Compliance

Check Vm Policy Compliance

Returns the storage policy Compliance Compliance.Info of a virtual machine after explicitly re-computing compliance check.

Get Vm Storage Policy Compliance

Returns the cached storage policy compliance information of a virtual machine.

Tools Installer

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

Disconnect Vm Tools Installer

Disconnect the VMware Tools installer CD image.

Get information about the VMware Tools installer.

Get Vm Tools Installer

Vm Template

Library Items

Create Vm Template Library Items

Deploy Template Library Item Library Items

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

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.

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

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

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.