Vcenter REST APIs Operations Index
All available Vcenter REST APIs Operations
Creates a new mapping that associates an object with a vTContainer instance. if you do not have all of the privileges described as follows:
- Operation execution requires Authorization.ModifyVTContainerMappings.
Returns the list of mappings indicating the containerized objects and their associated vTContainer instances. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
Removes a mapping. The related object will no longer be associated with the vTContainer instance. if you do not have all of the privileges described as follows:
- Operation execution requires Authorization.ModifyVTContainerMappings.
Returns information about a single mapping indicating the containerized object and its associated vTContainer instance. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
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.
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.
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.
Returns the rhttpproxy TLS certificate. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
Replaces the rhttpproxy TLS certificate with the specified certificate. This operation can be used in three scenarios :
- 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.
- 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.
- 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.
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.
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.
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.
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.
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.
Creates a new compute policy. if you do not have all of the privileges described as follows:
- Operation execution requires ComputePolicy.Manage.
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.
Deletes a specific compute policy. if you do not have all of the privileges described as follows:
- Operation execution requires ComputePolicy.Manage.
Returns information about a specific compute policy. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
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.
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.
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.
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.
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.
Returns the information about a specific zone. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
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.
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.
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.
Creates a Harbor registry in the cluster. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
- The resource ClusterComputeResource referenced by the attribute Harbor.CreateSpec.cluster requires System.Read.
- The resource SpsStorageProfile referenced by the attribute Harbor.StorageSpec.policy requires System.Read.
Returns basic information of all Harbor registries. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
Delete the Harbor registry in the cluster. All Harbor projects, repositories and images will be deleted upon Harbor registry deletion. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
- The resource com.vmware.vcenter.content.Registry referenced by the parameter registry requires System.Read.
Get detailed information of the Harbor registry. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
- The resource com.vmware.vcenter.content.Registry referenced by the parameter registry requires System.Read.
Creates a project in a Harbor registry using the supplied specification. In vSphere 7.0, a Harbor registry is deployed in a vSphere cluster with vSphere namespaces enabled. When a namespace is created, a project with same name as the namespace is created in the Harbor registry, so this operation should not be called. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
- The resource com.vmware.vcenter.content.Registry referenced by the parameter registry requires System.Read.
Returns basic information of all projects in a Harbor registry. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
- The resource com.vmware.vcenter.content.Registry referenced by the parameter registry requires System.Read.
Deletes the specified project from Harbor registry. Repositories and images in the project will be removed upon project deletion. Storage space of deleted images in the project will be reclaimed through next scheduled Harbor registry garbage collection. In vSphere 7.0, a Harbor registry is deployed in a vSphere cluster with vSphere namespaces enabled. When a namespace is deleted, a project with same name as the namespace is deleted from the Harbor registry, so this operation should not be called. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
- The resource com.vmware.vcenter.content.Registry referenced by the parameter registry requires System.Read.
- The resource com.vmware.vcenter.content.Registry.Harbor.Project referenced by the parameter project requires System.Read.
Returns detailed information about the specified Harbor project. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
- The resource com.vmware.vcenter.content.Registry referenced by the parameter registry requires System.Read.
- The resource com.vmware.vcenter.content.Registry.Harbor.Project referenced by the parameter project requires System.Read.
Remove all repositories, images and members in the project. Storage space of deleted images in the project will be reclaimed through next scheduled Harbor registry garbage collection. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
- The resource com.vmware.vcenter.content.Registry referenced by the parameter registry requires System.Read.
- The resource com.vmware.vcenter.content.Registry.Harbor.Project referenced by the parameter project requires System.Read.
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.
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.
Add a new provider. if you do not have all of the privileges described as follows:
- Operation execution requires Cryptographer.ManageKeyServers.
Return a list of providers.
if you do not have all of the privileges described as follows:
- Operation execution requires Cryptographer.ReadKeyServersInfo.
Remove a provider. if you do not have all of the privileges described as follows:
- Operation execution requires Cryptographer.ManageKeyServers.
Return information about a provider. if you do not have all of the privileges described as follows:
- Operation execution requires Cryptographer.ReadKeyServersInfo.
Update an existing provider. if you do not have all of the privileges described as follows:
- Operation execution requires Cryptographer.ManageKeyServers.
Export provider configuration. if you do not have all of the privileges described as follows:
- Operation execution requires Cryptographer.ManageKeyServers.
Import provider configuration. if you do not have all of the privileges described as follows:
- Operation execution requires Cryptographer.ManageKeyServers.
Cancels the task for importing vCenter historical data.
Get the current status of the vCenter historical data import.
Pauses the task for importing vCenter historical data.
Resumes the task for importing vCenter historical data.
Creates and starts task for importing vCenter historical data.
Cancel the appliance installation that is in progress.
Run sanity checks using the InstallSpec parameters passed.
Get the parameters used to configure the ongoing appliance installation.
Start the appliance installation.
Checks whether the provided remote PSC is reachable and can be replicated.
Cancel the appliance migration that is in progress.
Run sanity checks using the MigrateSpec parameters passed.
Get the MigrateSpec parameters used to configure the ongoing appliance migration.
Start the appliance migration.
Supply answer to the raised question.
Get the question that was raised during the configuration.
Cancel the appliance upgrade that is in progress.
Run sanity checks using the UpgradeSpec parameters passed.
Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
Start the appliance installation.
Creates a customization specification. if you do not have all of the privileges described as follows:
- Operation execution requires VirtualMachine.Provisioning.ModifyCustSpecs.
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.
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.
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.
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.
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.
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.
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.
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.
Creates a new hybrid link between the local and foreign PSC. Usage beyond VMware Cloud on AWS is not supported. if you do not have all of the privileges described as follows:
- Operation execution requires HLM.Manage.
Enumerates the list of registered hybrid links. Usage beyond VMware Cloud on AWS is not supported.
Deletes an existing hybrid link. This API should be used when unlink is initiated from Cloud Gateway. if you do not have all of the privileges described as follows:
- Operation execution requires HLM.Manage.
Gets information for a link. Usage beyond VMware Cloud on AWS is not supported. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
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. if you do not have all of the privileges described as follows:
- Operation execution requires HLM.Manage.
Add the local sso group with the new group. Usage beyond VMware Cloud on AWS is not supported. if you do not have all of the privileges described as follows:
- Operation execution requires HLM.Manage.
Enumerates the set of all the groups in the local sso group. Usage beyond VMware Cloud on AWS is not supported. if you do not have all of the privileges described as follows:
- Operation execution requires System.Read.
Sets the groups in the local sso group. Usage beyond VMware Cloud on AWS is not supported. if you do not have all of the privileges described as follows:
- Operation execution requires HLM.Manage.
Remove the group from the local sso group. Usage beyond VMware Cloud on AWS is not supported. if you do not have all of the privileges described as follows:
- Operation execution requires HLM.Manage.
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.
Delete a vCenter Server identity provider. if you do not have all of the privileges described as follows:
- Operation execution requires VcIdentityProviders.Manage.
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.
Update a vCenter Server identity provider. if you do not have all of the privileges described as follows:
- Operation execution requires VcIdentityProviders.Manage.
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.
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.
Associates a VMware product with vCenter Server manually. The product must be taken from the product catalog API. if you do not have all of the privileges described as follows:
- Operation execution requires VcLifecycle.View.
Retrieves a list of all associated VMware product deployments with vCenter Server in the environment. The list contains both product deployments discovered automatically and deployments registered manually through the API. if you do not have all of the privileges described as follows:
- Operation execution requires VcLifecycle.View.
Deletes or dissociates a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be deleted or dissociated. if you do not have all of the privileges described as follows:
- Operation execution requires VcLifecycle.View.
Returns the detailed information of a product associated with vCenter Server. if you do not have all of the privileges described as follows:
- Operation execution requires VcLifecycle.View.
Modifies a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be modified. if you do not have all of the privileges described as follows:
- Operation execution requires VcLifecycle.View.
Gets detailed update information. if you do not have all of the privileges described as follows:
- Operation execution requires VcLifecycle.View.
Lists all available minor and major updates. if you do not have all of the privileges described as follows:
- Operation execution requires VcLifecycle.View.
Returns information of NSX-T Tier0 Gateways associated with a Distributed Switch.
Get information about each available upgrade.
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.
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.
Get information about the default values associated with various sizes.
Disable vSphere Namespaces on the cluster. This operation tears down the Kubernetes instance and the worker nodes associated with vSphere Namespaces enabled cluster.
Enable vSphere Namespaces on the cluster. This operation sets up Kubernetes instance for the cluster along with worker nodes.
Returns information about a specific cluster.
Set a new configuration on the cluster object. The specified configuration is applied in entirety and will replace the current configuration fully.
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.
Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.
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.
Returns Namespaces compatibility information of Distributed Switches in vCenter associated with the vCenter cluster, matching the DistributedSwitchCompatibility.FilterSpec.
Returns Namespaces compatibility information of NSX-T Edge Clusters matching the EdgeClusterCompatibility.FilterSpec.
Returns support and licensing information about hosts under a VC.
Returns information LoadBalancers.Info about the load balancer associated with the given cluster.
Applies the entire load balancer spec to an existing load balancer configuration.
Updates the load balancer configuration. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.
Returns information about all load balancers associated with the given cluster.
Get the information about the objects used to set and update resource quota keys for version of Kubernetes running on {#link cluster}.
Create a vSphere Namespaces network object associated with the given cluster.
Return information about all vSphere Namespaces networks in the cluster.
Delete the vSphere Namespaces object in the cluster.
Return information about a specific vSphere Namespaces network.
Set a new configuration for the vSphere Namespaces network object associated with the given cluster.
Update the configuration of the vSphere Namespaces network object associated with the given cluster.
Returns basic information of the Distributed Switches matching the DistributedSwitches.FilterSpec.
Returns a list of Edges matching the given filter and their compatibility information.
Returns upgrade related information of a specific cluster.
Returns upgrade related information about all WCP enabled clusters.
Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted
Upgrade a set of clusters to its corresponding specific version.
Returns information about Supervisor upgrade pre-checks.
Run Supervisor upgrade pre-checks. This operation will initiate Supervisor upgrade pre-checks for a specific target version.
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.
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.
Create a Supervisor Service. If version specs are provided in the spec, new Supervisor Service versions will be created as part of the operation.
Return the information about all Supervisor Services on this vCenter.
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 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.
Return the information for the specified Supervisor Service.
Update a Supervisor Service.
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.
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 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.
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.
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.
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.
Create a Supervisor Service version based on the provided service definition information for the version.
Return the information about all versions of the Supervisor Service.
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 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.
Return the information for the specified Supervisor Service version.
Enable the Supervisor on a single vSphere cluster. This operation sets up the Kubernetes instance for the cluster along with worker nodes. A consumption fault domain 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.
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.
Get all conditions of a given Supervisor.
Defines a new container image registry for the given Supervisor.
Lists all container image registries on the given Supervisor.
Delete the given container image registry from the given Supervisor.
Get information about the given container image registry for the given Supervisor.
Update the given container image registry configuration for the given Supervisor.
Create a new identity provider to be used with a Supervisor. Currently, only a single identity provider can be created.
List the identity providers configured for a given Supervisor.
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.
Returns information about an identity provider configured for a Supervisor.
Update the entire configuration for an existing identity provider used with a Supervisor.
Update an existing identity provider used with a Supervisor.
Queries the current state of the specified Supervisor.
Queries the current state of all Supervisors. Optionally, apply the filter to Supervisors that match the criteria in the Summary.FilterSpec.
Get the result of the last valid SupervisorServices.precheck operation for a specific Supervisor Service version on a Supervisor. If the Supervisor Service on the Supervisor has been installed, upgraded or deleted since the last SupervisorServices.precheck operation, the stale result will be purged and the user should re-initiate a SupervisorServices.precheck operation.
Initiates a pre-check for installing or upgrading to a Supervisor Service version on the given Supervisor. For example, if a Supervisor is running version 1.0 of a service, use this API with a target version of 2.0 to know if the service version 2.0 is also compatible with this Supervisor. The pre-check result can be fetched asynchronously by SupervisorServices.get-precheck-result operation.
Create a VM class object.
Return information about all VirtualMachine classes.
Delete the VM class object.
Return information about a VM class.
Update the configuration of the VM class object
Set up access control for the subject on given domain on the namespace.
Remove access control of the subject on given domain from the namespace.
Get the information about the access control of the subject on given domain on the namespace.
Set new access control on the namespace for the subject on given domain.
Create a namespace object on a single vSphere cluster.
Returns the information about all namespaces in this vCenter Server. The information is tied to a single vSphere cluster.
Create a namespace object on a Supervisor.
Returns the information about all namespaces in this vCenter Server. The information is tied to a Supervisor.
Delete the namespace object in the cluster.
Returns information about a specific namespace on a single vSphere cluster.
Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.
Update the namespace object. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.
Returns information about a specific namespace on a Supervisor.
Register an existing virtual machine as VM Service managed VM. This API reads data stored in a VM's ExtraConfig to create a Kubernetes resource that may be used to lifecycle manage the VM. This process may also result in the creation of a Secret or ConfigMap resource for the VM's bootstrap data. Finally, a PersistentVolumeClaim resource may be created for each of the first-class disks attached to the VM.
This API triggers a non-cancellable task and returns its identifier which can be queried by calling the cis Tasks get operation. The task is retained as per the default retention rules configured in vCenter.
This is a non-idempotent API that creates custom resources on the Supervisor as a side effect. If the API returns an error VI admin might need to manually address them before attempting registration again.
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.
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.
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.
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.
Returns basic information about Namespace Self Service on all clusters on which vSphere Namespaces are enabled on this vCenter.
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.
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.
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.
Returns information about all the namespace templates associated with a Supervisor.
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.
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 the information about a namespace template on a Supervisor.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Return a list of configured TPMs on a host. if you do not have all of the privileges described as follows:
- The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.
Get 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.
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.
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.
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.
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.
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.
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.
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.
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.
Updates the state of a cluster.
Remove a trusted ESX base image of each ESX in the cluster.
Get the trusted ESX base version details.
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.
Return a list of trusted ESX base images.
Return the Attestation service health in the given cluster.
Add a new TPM CA certificate on a cluster.
Return a list of configured TPM CA certificates on a cluster.
Remove a TPM CA certificate on a cluster.
Get the TPM CA certificate details on a cluster.
Add a new TPM endorsement key on a cluster.
Return a list of configured TPM endorsement keys in a cluster.
Remove a TPM endorsement key on a cluster.
Get the TPM endorsement key details on a cluster.
Return the TPM 2.0 protocol settings.
Set the TPM 2.0 protocol settings.
Creates a profile with the specified connection information on all hosts from a Trust Authority Cluster.
Removes the read-only policy configured on ESX for a specific principal.
Retrieve information for a specific profile.
Lists all policies configured on a specific cluster.
Add a new Key Provider.
Return a list of summary of Key Providers.
Remove a Key Provider.
Return information about a Key Provider.
Update an existing Key Provider.
Generate a new self signed client certificate. Existing client certificate is overwritten. The key server will use this certificate to validate the client connection.
Return the existing client certificate.
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.
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 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.
Return the list of trusted server certificates.
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.
Return the Key Provider Service health in the given cluster.
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.
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.
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.
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.
Configures the cluster to use a the given registered Attestation Service.
Removes the Key Provider Service instance from the configuration of the given cluster.
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.
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.
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.
Returns detailed information about the health of the specified Attestation Service configuration applied to the cluster with respect to the desired state.
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.
Returns basic information about the health of all Attestation Service configurations applied to the cluster with respect to the desired state.
Configures the cluster to use a the given registered Key Provider Service.
Removes the Key Provider Service instance from the configuration of the given cluster.
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.
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.
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.
Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state.
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.
Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state.
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.
Returns detailed information about the health of the applied Trust Authority Component configurations in the given cluster.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec.
Create a new datacenter in the vCenter inventory
Returns information about at most 1000 visible (subject to permission checks) datacenters in vCenter matching the Datacenter.FilterSpec.
Delete an empty datacenter from the vCenter Server
Retrieves information about the datacenter corresponding to datacenter.
Retrieves information about the datastore indicated by datastore.
Returns information about at most 2500 visible (subject to permission checks) datastores in vCenter matching the Datastore.FilterSpec.
Get the current status of the appliance deployment.
Rollback a failed appliance so it can be configured once again.
Connect to the host corresponding to host previously added to the vCenter server.
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.
Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.
Remove a standalone host from the vCenter Server.
Disconnect the host corresponding to host from the vCenter server
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.
Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePool.FilterSpec.
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.
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.
Prepares, clones, and configures a VCHA cluster.
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:
- Cluster's mode is enabled and all cluster members are present.
- Cluster's mode is maintenance and all cluster members are present.
Retrieves the status of a VCHA cluster.
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.
Retrieves the deployment type of a VCHA cluster.
Retrieves the current mode of a VCHA cluster.
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.
Validates the specified passive node's placement configuration.
Creates the passive node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.
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.
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.
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 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Returns details of the local file systems in the guest operating system.
Returns information about the guest operating system power state.
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.
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.
Issues a request to the guest operating system asking it to perform a suspend operation.
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.
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.
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.
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.
Returns the virtual hardware settings of a virtual machine.
Updates the virtual hardware settings of a virtual machine.
Upgrades the virtual machine to a newer virtual hardware version.
Adds a virtual NVMe adapter to the virtual machine.
Returns commonly used information about the virtual NVMe adapters belonging to the virtual machine.
Removes a virtual NVMe adapter from the virtual machine.
Returns information about a virtual NVMe adapter.
Adds a virtual SATA adapter to the virtual machine.
Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.
Removes a virtual SATA adapter from the virtual machine.
Returns information about a virtual SATA adapter.
Adds a virtual SCSI adapter to the virtual machine.
Returns commonly used information about the virtual SCSI adapters belonging to the virtual machine.
Removes a virtual SCSI adapter from the virtual machine.
Returns information about a virtual SCSI adapter.
Updates the configuration of a virtual SCSI adapter.
Returns the boot-related settings of a virtual machine.
Updates the boot-related settings of a virtual machine.
Returns an ordered list of boot devices for the virtual machine. If the list is empty, the virtual machine uses a default boot sequence.
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.
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.
Returns commonly used information about the virtual CD-ROM devices belonging to the virtual machine.
Removes a virtual CD-ROM device from the virtual machine.
Returns information about a virtual CD-ROM device.
Updates the configuration of a virtual CD-ROM device.
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.
Returns the CPU-related settings of a virtual machine.
Updates the CPU-related settings of a virtual machine.
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.
Returns commonly used information about the virtual disks belonging to the virtual machine.
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.
Returns information about a virtual disk.
Updates the configuration of a virtual disk. An update operation can be used to detach the existing VMDK file and attach another VMDK file to the virtual machine.
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.
Adds a virtual Ethernet adapter to the virtual machine.
Returns commonly used information about the virtual Ethernet adapters belonging to the virtual machine.
Removes a virtual Ethernet adapter from the virtual machine.
Returns information about a virtual Ethernet adapter.
Updates the configuration of a virtual Ethernet adapter.
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.
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.
Adds a virtual floppy drive to the virtual machine.
Returns commonly used information about the virtual floppy drives belonging to the virtual machine.
Removes a virtual floppy drive from the virtual machine.
Returns information about a virtual floppy drive.
Updates the configuration of a virtual floppy drive.
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.
Returns the memory-related settings of a virtual machine.
Updates the memory-related settings of a virtual machine.
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.
Adds a virtual parallel port to the virtual machine.
Returns commonly used information about the virtual parallel ports belonging to the virtual machine.
Removes a virtual parallel port from the virtual machine.
Returns information about a virtual parallel port.
Updates the configuration of a virtual parallel port.
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.
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.
Adds a virtual serial port to the virtual machine.
Returns commonly used information about the virtual serial ports belonging to the virtual machine.
Removes a virtual serial port from the virtual machine.
Returns information about a virtual serial port.
Updates the configuration of a virtual serial port.
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.
Returns the information about the library item associated with the virtual machine.
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.
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.
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.
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.
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.
Returns Information about Storage Policy associated with a virtual machine's home directory and/or its virtual hard disks.
Updates the storage policy configuration of a virtual machine and/or its associated virtual hard disks.
Returns the storage policy Compliance Compliance.Info of a virtual machine after explicitly re-computing compliance check.
Returns the cached storage policy compliance information of a virtual machine.
Get the properties of VMware Tools.
Update the properties of VMware 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.
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 the VMware Tools installer CD image.
Get information about the VMware Tools installer.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.