Vcenter REST APIs Operations Index
All available Vcenter REST APIs Operations
Certificate Authority
Certificate
GET
Get Internal
Verify the provided certificate on the server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires CertificateAuthority.Manage and CertificateAuthority.Administer.
GET
Get Internal
Get the count of certificates on the server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires CertificateAuthority.Manage and CertificateAuthority.Administer.
GET
Get Internal
List all the certs in the server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires CertificateAuthority.Manage and CertificateAuthority.Administer.
POST
Gen Cert Internal
Get the signed certificate for the given Spec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires CertificateAuthority.Manage and CertificateAuthority.Administer.
POST
Generate Keys Internal
Generate the public and private key pair for given keysize. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires CertificateAuthority.Manage and CertificateAuthority.Administer.
Certificate Management Vcenter
Tls
GET
Get Certificate Management Tls
Returns the rhttpproxy TLS certificate. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
PUT
Set Certificate Management Tls
Replaces the rhttpproxy TLS certificate with the specified certificate. This operation can be used in three scenarios : 1. When the CSR is created and the private key is already stored, this operation can replace the certificate. The Tls.Spec.cert (but not Tls.Spec.key and Tls.Spec.root-cert) must be provided as input. 2. When the certificate is signed by a third party certificate authority/VMCA and the root certificate of the third party certificate authority/VMCA is already one of the trusted roots in the trust store, this operation can replace the certificate and private key. The Tls.Spec.cert and Tls.Spec.key (but not Tls.Spec.root-cert) must be provided as input. 3. When the certificate is signed by a third party certificate authority and the root certificate of the third party certificate authority is not one of the trusted roots in the trust store, this operation can replace the certificate, private key and root CA certificate. The Tls.Spec.cert,Tls.Spec.key and Tls.Spec.root-cert must be provided as input. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. The above three scenarios are only supported from vsphere 7.0 onwards. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Administer.
POST
Renew Tls
Renews the TLS certificate for the given duration period. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Administer.
POST
Replace Vmca Signed Tls
Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Administer.
Trusted Root Chains
POST
Create Certificate Management Trusted Root Chains
Creates a new trusted root certificate chain from the CreateSpec. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Manage and CertificateManagement.Administer.
GET
List Certificate Management Trusted Root Chains
Returns summary information for each trusted root certificate chain. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
DELETE
Delete Chain Certificate Management Trusted Root Chains
Deletes trusted root certificate chain for a given identifier. if you do not have all of the privileges described as follows: - Operation execution requires CertificateManagement.Manage and CertificateManagement.Administer.
GET
Get Chain Certificate Management Trusted Root Chains
Retrieve a trusted root certificate chain for a given identifier. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
Cluster
Modules
POST
Create Cluster Modules Internal
Creates a new module in a vCenter cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
List Cluster Modules Internal
Returns information about the modules available in this vCenter server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DELETE
Delete Module Cluster Internal
Deletes a specific module. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Edrs Algo Parameter
GET
Get Cluster Edrs Algo Parameter Internal
Gets EDRS algorithm parameters for a given cluster. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.
PUT
Set Cluster Edrs Algo Parameter Internal
Sets EDRS algorithm parameters for a given cluster. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - The resource ClusterComputeResource referenced by the parameter cluster requires Host.Inventory.EditCluster.
Edrs Maintenance Mode
POST
Enter Cluster Edrs Maintenance Mode Internal
Request the cluster to enter the maintenance mode, EDRS would generate the scaling recommendation based on cluster resources utilization. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - The resource ClusterComputeResource referenced by the parameter cluster requires Host.Inventory.EditCluster.
POST
Enter Cluster Edrs Maintenance Mode Async Internal
Request the cluster to enter the maintenance mode, EDRS would generate the scaling recommendation based on cluster resources utilization. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - The resource ClusterComputeResource referenced by the parameter cluster requires Host.Inventory.EditCluster.
POST
Exit Cluster Edrs Maintenance Mode Internal
Request the cluster to exit the maintenance mode, EDRS would generate the scaling recommendation based on cluster resources utilization. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - The resource ClusterComputeResource referenced by the parameter cluster requires Host.Inventory.EditCluster.
POST
Exit Cluster Edrs Maintenance Mode Async Internal
Request the cluster to exit the maintenance mode, EDRS would generate the scaling recommendation based on cluster resources utilization. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - The resource ClusterComputeResource referenced by the parameter cluster requires Host.Inventory.EditCluster.
GET
Get Cluster Edrs Maintenance Mode Internal
Get the status of the cluster maintenance mode. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.
Modules Vm Members
POST
Add Module Members Internal
Adds virtual machines to the module. These virtual machines are required to be in the same vCenter cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Module Vm Members Internal
Returns the virtual machines that are members of the module. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Remove Module Members Internal
Removes virtual machines from the module. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Compute
Policies
POST
Create Compute Policies Internal
Creates a new compute policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - Operation execution requires ComputePolicy.Manage.
GET
List Compute Policies Internal
Returns information about the compute policies available in this vCenter server in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
DELETE
Delete Policy Compute Policies Internal
Deletes a specific compute policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - Operation execution requires ComputePolicy.Manage.
GET
Get Policy Compute Policies Internal
Returns information about a specific compute policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
Policies Capabilities
GET
Get Capability Policies Capabilities Internal
Returns information about a specific compute policy capability in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
GET
List Compute Policies Capabilities Internal
Returns information about the compute policy capabilities available in this vCenter server in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
Content Registries
Harbor
POST
Create Content Registries Harbor
Creates a Harbor registry in the cluster.
GET
List Content Registries Harbor
Returns basic information of all Harbor registries.
DELETE
Delete Registry Registries Harbor
Delete the Harbor registry in the cluster. All Harbor projects, repositories and images will be deleted upon Harbor registry deletion.
GET
Get Registry Registries Harbor
Get detailed information of the Harbor registry.
Content Registries Harbor
Projects
POST
Create Registry Harbor Projects
Creates a project in a Harbor registry using the supplied specification. In vSphere 7.0, a Harbor registry is deployed in a vSphere cluster with vSphere namespaces enabled. When a namespace is created, a project with same name as the namespace is created in the Harbor registry, so this operation should not be called.
GET
List Registry Harbor Projects
Returns basic information of all projects in a Harbor registry.
DELETE
Delete Registry Project Harbor
Deletes the specified project from Harbor registry. Repositories and images in the project will be removed upon project deletion. Storage space of deleted images in the project will be reclaimed through next scheduled Harbor registry garbage collection. In vSphere 7.0, a Harbor registry is deployed in a vSphere cluster with vSphere namespaces enabled. When a namespace is deleted, a project with same name as the namespace is deleted from the Harbor registry, so this operation should not be called.
GET
Get Registry Project Harbor
Returns detailed information about the specified Harbor project.
POST
Purge Registry Project
Remove all repositories, images and members in the project. Storage space of deleted images in the project will be reclaimed through next scheduled Harbor registry garbage collection.
Content Registries Harbor Project
Members
POST
Create Registry Project Harbor Members Internal
Create a project member for specified Harbor project.
GET
List Registry Project Harbor Members Internal
Returns all members basic information in the specified Harbor project.
DELETE
Delete Registry Project Member Registry Internal
Remove a project member from specified Harbor project.
GET
Get Registry Project Member Registry Internal
Get detailed Harbor project member information for specified user or group.
PATCH
Update Registry Project Member Registry Internal
Update access control for a member in a registry project.
Datastore
Deployment
Import History
POST
Cancel Deployment History
Cancels the task for importing vCenter historical data.
GET
Get Deployment History
Get the current status of the vCenter historical data import.
POST
Pause Deployment History
Pauses the task for importing vCenter historical data.
POST
Resume Deployment History
Resumes the task for importing vCenter historical data.
POST
Start Deployment History
Creates and starts task for importing vCenter historical data.
Install
POST
Cancel Deployment Install
Cancel the appliance installation that is in progress.
POST
Check Deployment Install
Run sanity checks using the InstallSpec parameters passed.
GET
Get Deployment Install
Get the parameters used to configure the ongoing appliance installation.
POST
Start Deployment Install
Start the appliance installation.
Migrate
POST
Cancel Deployment Migrate
Cancel the appliance migration that is in progress.
POST
Check Deployment Migrate
Run sanity checks using the MigrateSpec parameters passed.
GET
Get Deployment Migrate
Get the MigrateSpec parameters used to configure the ongoing appliance migration.
POST
Start Deployment Migrate
Start the appliance migration.
Question
POST
Answer Deployment Question
Supply answer to the raised question.
GET
Get Deployment Question
Get the question that was raised during the configuration.
Upgrade
POST
Cancel Deployment Upgrade
Cancel the appliance upgrade that is in progress.
POST
Check Deployment Upgrade
Run sanity checks using the UpgradeSpec parameters passed.
GET
Get Deployment Upgrade
Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
POST
Start Deployment Upgrade
Start the appliance installation.
Install Remote Psc
POST
Check Install Remote Psc
Checks whether the remote PSC is reachable and the deployed vCenter Server can be registered with the remote PSC.
Install Initial Config Remote Psc Thumbprint
GET
Get Initial Config Remote Psc Thumbprint
Gets the SHA1 thumbprint of the remote PSC.
Install Psc Replicated
POST
Check Psc Replicated
Checks whether the provided remote PSC is reachable and can be replicated.
Extension
Tasks
POST
Create Extension Tasks Internal
Returns a taskId for the task using the CreateSpec. The taskId can be used for querying or updating the status of the task by the client. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PATCH
Update Task Id Extension Internal
Updates the information of the operation associated with a task on the ManagedObjects. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Files Nfc Tickets
Guest
Customization Specs
POST
Create Guest Customization Specs
Creates a customization specification.
GET
List Guest Customization Specs
Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec.
DELETE
Delete Name Guest Customization Specs
Deletes a customization specification with the specified identifier.
GET
Get Name Guest Customization Specs
Returns the guest customization specification from vCenter with the specified identifier.
POST
Create Name Guest Customization Specs
Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.get) and editing it.
POST
Export Name Customization Specs
Returns the content of the customization specification in the specified format. Note that any passwords in the customization specification will be set to blank values during the export operation.
POST
Import Guest Customization Specs
Converts a well formatted string to a CustomizationSpecs.CreateSpec. The resulting object can be passed to CustomizationSpecs.create operation.
Hlm
Community
POST
Add Hlm Community Async Internal
Adds the target node to the community. By default, the first member of the community id the local node. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Check Hlm Community Internal
Performs network checks between nodes in the community. This can be called before the add to validate network requirements prior to performing the action or after adding to check network connectivity within a peers of a community. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Check Hlm Community Async Internal
Performs network checks between nodes in the community. This can be called before the add to validate network requirements prior to performing the action or after adding to check network connectivity within a peers of a community. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Hlm Community Internal
Information about the community. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Remove Hlm Community Async Internal
Removes a specified node from a community. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Host
Tags
POST
Add Host Tags Internal
Attaches tags to a host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Host Tags Internal
Lists all tags attached to the host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Remove Host Tags Internal
Detaches tags from a host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Features Tech Preview
GET
Get Host Features Tech Preview Internal
Returns the current status of the feature switches in Tech Preview mode for the feature names in the input set. If the input set is empty, returns the status of all the features. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PATCH
Update Host Features Tech Preview Internal
Sets the status to enabled/disabled for the Tech Preview feature switches passed in the input map. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Maintenance Requests V1
POST
Create Maintenance Requests V1 Internal
Creates a maintenance request on multiple hosts. If a maintenance request already exists for a host with the same description, then the exiting request identifier is returned.
POST
Delete Maintenance Requests V1 Internal
Deletes the given set of maintenance requests.
GET
List Host Maintenance Requests V1 Internal
Returns information about maintenance requests matching the RequestsV1.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
Hvc
Links
POST
Create Hvc Links Internal
Creates a new hybrid link between the local and foreign PSC. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
GET
List Hvc Links Internal
Enumerates the list of registered hybrid links. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
DELETE
Delete Link Hvc Internal
Deletes an existing hybrid link. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Links Sync Providers
GET
Get Link Provider Sync Internal
Gets Sync information for a sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
GET
List Link Hvc Sync Providers Internal
Enumerates the sync providers. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
POST
Start Link Provider Internal
Initiates synchronization between the local and remote replicas for the sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Management Administrators
POST
Add Management Administrators Internal
Add the local sso group with the new group. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
GET
Get Hvc Management Administrators Internal
Enumerates the set of all the groups in the local sso group. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
PUT
Set Hvc Management Administrators Internal
Sets the groups in the local sso group. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
POST
Remove Management Administrators Internal
Remove the group from the local sso group. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Identity
Foreign Security Principals
POST
Create Identity Foreign Security Principals Internal
Create a foreign security principal. If the same Id already exists, update the record. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.
GET
Get Principal Identity Foreign Security Principals Internal
Retrieve foreign security principal based on the identifier. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.
GET
Get Identity Foreign Security Principals Domains Internal
Retrieve all domain names associated with foreign security principals. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.
PATCH
Update Id Foreign Security Principals Internal
Update a foreign security principal. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.
Providers
POST
Create Identity Providers
Create a vCenter Server identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Create and VcIdentityProviders.Manage.
GET
List Identity Providers
Retrieve all identity providers. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.
DELETE
Delete Provider Identity
Delete a vCenter Server identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.
GET
Get Provider Identity
Retrieve detailed information of the specified identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.
PATCH
Update Provider Identity
Update a vCenter Server identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.
Vc Identity
GET
Get Identity Internal
Retrieve VcIdentity for local domain. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
PATCH
Update Identity Internal
Update the VcIdentity for local domain with data in given UpdateSpec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires Trust.Manage and Trust.Administer.
Inventory
Iso
Image
POST
Mount Library Item
Mounts an ISO image from a content library on a virtual machine. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Config.AddRemoveDevice. - The resource com.vmware.content.library.Item referenced by the parameter libraryItem requires ContentLibrary.DownloadSession.
POST
Unmount Vm
Unmounts a previously mounted CD-ROM using an ISO image as a backing. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Config.AddRemoveDevice. - The resource com.vmware.vcenter.vm.hardware.Cdrom referenced by the parameter cdrom requires System.Read.
Lcm
Install
POST
Check Lcm Install Internal
Performs a precheck for the given specification. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Start Lcm Install Internal
Deploys the appliance for the given specification. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Discovery Associated Products
POST
Create Lcm Discovery Associated Products
Associates a VMware product with vCenter Server manually. The product must be taken from the product catalog API.
GET
List Lcm Discovery Associated Products
Retrieves a list of all associated VMware product deployments with vCenter Server in the environment. The list contains both product deployments discovered automatically and deployments registered manually through the API.
DELETE
Delete Product Discovery Associated Products
Deletes or dissociates a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be deleted or dissociated.
GET
Get Product Discovery Associated Products
Returns the detailed information of a product associated with vCenter Server.
PATCH
Update Product Discovery Associated Products
Modifies a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be modified.
Discovery Product Catalog
GET
List Lcm Discovery Product Catalog
Retrieves a list of all VMware products that can be associated with vCenter Server.
Install Scheduled
GET
Get Task Install Scheduled Internal
Retrieves information of the install operation that has the given id. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PUT
Set Task Install Scheduled Internal
Updates the information of the task that has the given identifier. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Namespace Management
Cluster Available Versions
GET
List Namespace Management Software Cluster Available Versions
Get information about each available upgrade.
Cluster Size Info
GET
Get Namespace Management Cluster Size Info
Get information about the default values associated with various sizes.
Clusters
POST
Disable Cluster
Disable vSphere Namespaces on the cluster. This operation tears down the Kubernetes instance and the worker nodes associated with vSphere Namespaces enabled cluster.
POST
Enable Cluster
Enable vSphere Namespaces on the cluster. This operation sets up Kubernetes instance for the cluster along with worker nodes.
GET
Get Cluster Namespace Management
Returns information about a specific cluster.
PUT
Set Cluster Namespace Management
Set a new configuration on the cluster object. The specified configuration is applied in entirety and will replace the current configuration fully.
PATCH
Update Cluster Namespace Management
Update configuration on the cluster object. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.
GET
List Namespace Management Clusters
Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.
POST
Rotate Password Cluster
Request a new root password for all control plane nodes in the cluster. This operation generates a new root password and configures every control plane node in the cluster to accept it for authentication.
Distributed Switch Compatibility
GET
List Namespace Management Distributed Switch Compatibility
Returns Namespaces compatibility information of Distributed Switches in vCenter associated with the vCenter cluster, matching the DistributedSwitchCompatibility.FilterSpec.
Edge Cluster Compatibility
GET
List Namespace Management Edge Cluster Compatibility
Returns Namespaces compatibility information of NSX-T Edge Clusters matching the EdgeClusterCompatibility.FilterSpec.
Hosts Config
GET
Get Namespace Management Capability
Returns support and licensing information about hosts under a VC.
Load Balancers
GET
Get Cluster Id Namespace Management Load Balancers
Returns information LoadBalancers.Info about the load balancer associated with the given cluster.
GET
List Cluster Namespace Management Load Balancers
Returns information about all load balancers associated with the given cluster.
Namespace Resource Options
GET
Get Cluster Namespace Management Workload Resource Options
Get the information about the objects used to set and update resource quota keys for version of Kubernetes running on {#link cluster}.
Networks
GET
List Cluster Namespace Management Networks
Return information about all vSphere Namespaces networks in the cluster.
GET
Get Cluster Network Namespace Management
Return information about a specific vSphere Namespaces network.
Nodes
POST
Enter Maintenance Mode Cluster Nodes Internal
Enter Namespaces maintenance mode on the node. This operation removes Kubernetes pods from the given node and prevents further scheduling of pods on the node. This operation can be cancelled by calling exitMaintenanceMode operation on the node.
POST
Exit Maintenance Mode Cluster Nodes Internal
Exit Namespaces maintenance mode on the node. This operation enables scheduling of Kubernetes pods on the node.
Supervisor Services
POST
Create Namespace Management Supervisor Services Internal
Create a supervisor service. If version specs are provided in the spec, new supervisor service versions will be created as part of the operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
List Namespace Management Supervisor Services Internal
Return the information about all supervisor services on this vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DELETE
Delete Supervisor Service Namespace Management Internal
Delete a supervisor service. All versions of this service which are enabled in the vSphere Supervisor clusters will be removed. This will also remove the service from vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Supervisor Service Namespace Management Internal
Return the information for the specified supervisor service. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PATCH
Update Supervisor Service Namespace Management Internal
Update a supervisor service. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Certificate Management Tls Csr
POST
Create Cluster Csr Tls Endpoint Internal
Create a Certificate Signing Request for Kubernetes API Server. Certificate issued using this request can be used to update cluster configuration using {name UpdateSpec}.
POST
Create Cluster Csr Ncp Default Ingress Tls Internal
Create a Certificate Signing Request used by NSX as a default, fallback certificate for Kubernetes Ingress objects. The certificate issued using this request can be used to update cluster configuration using {name UpdateSpec}.
Events Events
GET
Get Cluster Namespace Management Events Internal
Returns Kubernetes events related to a specific cluster.
Software Clusters
GET
Get Cluster Namespace Management Software
Returns upgrade related information of a specific cluster.
GET
List Namespace Management Software Clusters
Returns upgrade related information about all WCP enabled clusters.
POST
Upgrade Cluster
Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted
POST
Upgrade Multiple Software Clusters
Upgrade a set of clusters to its corresponding specific version.
Stats Time Series
GET
Get Namespace Management Stats Time Series
Gather statistical values for a cluster, namespace, or pod.
Supervisor Services Versions
POST
Create Supervisor Service Namespace Management Versions Internal
Create a supervisor service version based on the provided service definition information for the version. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
List Supervisor Service Namespace Management Versions Internal
Return the information about all versions of the supervisor service. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DELETE
Delete Supervisor Service Version Namespace Management Internal
Delete a supervisor service version. This operation deletes the supervisor service version from vCenter and tears down all resources for the service version in the vSphere Supervisor clusters that have the supervisor service version enabled. Note that deleting the last version of the supervisorService does not delete the supervisorService instance automatically. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Supervisor Service Version Namespace Management Internal
Return the information for the specified supervisor service version. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Namespaces
Access
POST
Create Namespace Domain Subject Access
Set up access control for the subject on given domain on the namespace.
DELETE
Delete Namespace Domain Subject Access
Remove access control of the subject on given domain from the namespace.
GET
Get Namespace Domain Subject Access
Get the information about the access control of the subject on given domain on the namespace.
PUT
Set Namespace Domain Subject Access
Set new access control on the namespace for the subject on given domain.
Instances
POST
Create Namespaces Instances
Create namespace object in the cluster.
GET
List Namespaces Instances
Returns the information about all namespaces on this vCenter.
DELETE
Delete Namespace Instances
Delete the namespace object in the cluster.
GET
Get Namespace Instances
Returns information about a specific namespace.
PUT
Set Namespace Instances
Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.
PATCH
Update Namespace Instances
Update the namespace object. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.
Events Events
GET
Get Namespace Events Internal
Returns Kubernetes events related to a specific namespace.
Systemregistry Instances
POST
Create Namespaces Systemregistry Instances Internal
Create a namespace object whose name prefixed with "vmware-system-registry" for an integrated registry in the cluster.
DELETE
Delete Namespace Systemregistry Instances Internal
Delete the namespace object created for an integrated registry in the cluster.
Network
Nsx
Edge Clusters
GET
Get Cluster Nsx Edge Clusters Internal
Return information about NSX Edge cluster specification on a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Update Cluster Internal
Update NSX Edge capabilities of an existing NSX Edge cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Ip Pools
GET
Get Ip Pool Nsx Internal
Read the NSX IP pool. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
List Nsx Ip Pools Internal
Returns the list of the NSX IP pools. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Recovery
POST
Execute Nsx Recovery Internal
Recovers the system from the loss of WCP service and/or NSX. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Recovery Execute Status Internal
Gets the recovery status. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Get Nsx Recovery Internal
Returns whether recovery is needed. If needed, then returns the type of loss that needs recovery. If recovery is not needed, then clears the recovery state to allow the WCP service to enter steady state. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Clusters Configuration
POST
Disable Cluster Configuration Internal
Disables NSX networking on the hosts in a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Enable Cluster Configuration Internal
Enables NSX networking on the hosts in a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Clusters Validation
POST
Check Edge Cluster Update Spec Cluster Validation Internal
Performs validation checks on the specification that can be used to update NSX Edge capabilities in an existing NSX Edge Cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Check Enable Specs Cluster Validation Internal
Performs validation checks on the specification that can be used for enabling NSX networking with transport node configuration on all the hosts in a vSphere cluster and enabling NSX Edge cluster in a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Deployment Compatibility
GET
Get Deployment Compatibility Latest Version Internal
Gets the latest update or patch version of the latest supported NSX binary available in my.vmware.com portal. This will be utilized by customers having the access to my.vmware.com portal from vCenter server. This operation requires that vCenter has internet access. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Nsx Deployment Compatibility Internal
Gets the compatibility information between the currently installed NSX version and the current vCenter Server version. This operation is executed against data bundled in vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Deployment Install
POST
Cancel Deployment Install Internal
Cancels the ongoing NSX installation on the current vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Nsx Deployment Install Internal
Gets the NSX appliance deployment status on the current vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Start Deployment Install Internal
Starts the NSX appliance deployment on the current vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Uninstall Deployment Install Internal
Uninstalls the NSX appliance deployed on the current vCenter. This API can only uninstall NSXI and cannot be used to uninstall NSXT. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Deployment License
GET
Get Nsx Deployment License Internal
Gets the NSX licensing details applied to the NSX Manager Appliance. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PATCH
Update Nsx Deployment License Internal
Updates the license key on the NSX Manager Appliance. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Validate Deployment License Internal
Validates the license key. This operation checks if the license key can be successfully applied and is a valid WCP license. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Deployment Software Package
POST
Cancel Deployment Software Package Internal
Cancel running NSX download or upload process. This would interrupt the NSX binary upload or download process and clean up the NSX binary being uploaded. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Download Deployment Software Package Internal
Download NSX binaries from the my.vmware.com portal on vCenter Server. To call this API user needs to first Authenticate, then get List of accounts, select a listed account and check its entitlement and then invoke download. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Nsx Deployment Software Package Internal
Gets Stage operation status like MUB file staged version, staging in progress, stage percentage etc. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Upload Deployment Software Package Internal
Upload NSX binaries to vCenter server. This API would provide the URI which has to be used to upload the content. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Deployment Upgrade
POST
Check Deployment Upgrade Internal
Runs checks for available NSX upgrade. This is an asynchronous call with fast return. The result of the operation can be queried by calling the Upgrade.get operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Nsx Deployment Upgrade Internal
Gets NSX deployment information, this includes the overall upgrade status, the available release version, the last precheck run time, the current operation details and the list of clusters with their upgrade status. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Pause Deployment Upgrade Internal
Pauses already running NSX upgrade. This is an asynchronous call with fast return. The result of the operation can be queried by calling the Upgrade.get operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Resume Deployment Upgrade Internal
Resumes already paused NSX upgrade. This is an asynchronous call with fast return. The result of the operation can be queried by calling the Upgrade.get operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Start Deployment Upgrade Internal
Applies available NSX upgrade. This is an asynchronous call with fast return. The result of the operation can be queried by calling the Upgrade.get operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Edge Clusters Configuration
POST
Disable Cluster Configuration Internal
Disables NSX Edge capabilities in a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Enable Cluster Configuration Internal
Enable NSX Edge capabilities in a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Ovf
Export Session
POST
Create Ovf Export Session Internal
Creates a new export session for a virtual machine or virtual appliance. The state of the new export session is EXPORT_PREPARING. This operation is idempotent. Two calls with the same client token will receive the same export session object. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource VirtualApp referenced by the attribute ExportSession.SourceInfo.vapp-id requires System.Read. - The resource VirtualMachine referenced by the attribute ExportSession.SourceInfo.vm-id requires System.Read. - The resource com.vmware.content.Library referenced by the attribute ExportSession.CreateSpec.content-library requires System.Read. - The resource com.vmware.content.library.Item referenced by the attribute ExportSession.CreateSpec.content-library-item requires System.Read.
DELETE
Delete Id Export Session Internal
Deletes (or cancels) an export session. If no export session with the specified identifier exists, this call will return with success. A client should terminate a session to free up resources on the server. An export session will automatically be reclaimed after a period of inactivity. For example, it will only remain in EXPORT_ERROR and EXPORT_COMPLETED state for a period of time. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfExportSession referenced by the parameter id requires System.Read.
GET
Get Id Export Session Internal
Retrieves information about an export session. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfExportSession referenced by the parameter id requires System.Read.
POST
Preview Ovf Export Session Internal
Do a preview of an export for a virtual machine of virtual appliance. This can be used to get an overview of the files that will need to be transferred during the actual export. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource VirtualApp referenced by the attribute ExportSession.SourceInfo.vapp-id requires System.Read. - The resource VirtualMachine referenced by the attribute ExportSession.SourceInfo.vm-id requires System.Read.
POST
Progress Id Internal
Used by the client to set the progress of download when target is DOWNLOAD_TARGET. Should be called regularly to keep the given export session alive. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfExportSession referenced by the parameter id requires System.Read.
Import Session
POST
Create For Resource Pool Resource Pool Internal
Creates an import session that can instantiate an OVF package to a resource pool. This operation is idempotent. Two calls with the same client token will receive the same import session object. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource ResourcePool referenced by the parameter resourcePool requires System.Read. - The resource HostSystem referenced by the parameter hostSystem requires System.Read. - The resource Folder referenced by the parameter folder requires System.Read. - The resource com.vmware.content.library.Item referenced by the attribute ImportSession.CreateSpec.content-library-item requires System.Read.
DELETE
Delete Id Import Session Internal
Deletes (or cancels) an import session. A client should terminate a session to free up resources on the server. An import session will automatically be reclaimed after a period of inactivity. For example it will only remain in IMPORT_ERROR and IMPORT_COMPLETED state for a period of time. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfImportSession referenced by the parameter id requires System.Read.
GET
Get Id Import Session Internal
Retrieves information about an import session. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfImportSession referenced by the parameter id requires System.Read.
POST
Instantiate Id Internal
Instantiates the virtual machine or virtual appliance. This method is only valid to call with an import session in state IMPORT_SELECTING_OVF_PARAMS. During the execution of this method the session state will progress over IMPORT_FILE_TRANSFER and IMPORT_INSTANTIATING to IMPORT_COMPLETED. This method must be called to complete the session. After the call it is an error to call instantiate. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfImportSession referenced by the parameter id requires System.Read.
POST
Preview Ovf Import Session Internal
Do a preview of an OVF descriptor. This can be used to get an overview of the required files that need to be transferred, and basic validation result during an OVF template import. The OVF descriptor can be in plain text or compressed by gzip and followed by base64 encoding. Note that the compression must be gzip and must be encoded with base64 after compression, otherwise InvalidArgument exception will be thrown. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
POST
Probe Ovf Import Session Internal
if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
POST
Progress Id Internal
Used by the client to set the progress of disk upload when the source type is PUSH_SOURCE. Should be called regularly to keep the given export session alive. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfImportSession referenced by the parameter id requires System.Read.
POST
Try Instantiate Id Internal
Returns information about the instantiation parameters that can be specified for the import session when an import session is in the IMPORT_SELECTING_OVF_PARAMS state. The instantiation parameters returned may depend on the choices specified in any instantiation parameters provided as input arguments. This method can be iteratively called with progressively more detailed instantiation parameters. The operation does not change the state of the import session. The call must supply all instantiation parameters each time. They are not remembered from one invocation to the next. This also means that the operation is naturally idempotent. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfImportSession referenced by the parameter id requires System.Read.
Library Item
POST
Create Ovf Library Item
Creates a library item in content library from a virtual machine or virtual appliance. This operation creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this operation, the original content is overwritten. Meta data such as name and description is not updated for the exisitng library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource null or null referenced by the attribute LibraryItem.DeployableIdentity.id requires VApp.Export. - The resource com.vmware.content.Library referenced by the attribute LibraryItem.CreateTarget.library-id requires ContentLibrary.AddLibraryItem. - The resource com.vmware.content.library.Item referenced by the attribute LibraryItem.CreateTarget.library-item-id requires System.Read.
POST
Deploy Ovf Library Item Id
Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance. This operation deploys an OVF package which is stored in the library item specified by ovfLibraryItemId. It uses the deployment specification in deploymentSpec to deploy the OVF package to the location specified by target. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter ovfLibraryItemId requires System.Read. - The resource HostSystem referenced by the attribute LibraryItem.DeploymentTarget.host-id requires System.Read. - The resource Network referenced by the map value of attribute LibraryItem.ResourcePoolDeploymentSpec.network-mappings requires System.Read. - The resource StorageProfile referenced by the attribute LibraryItem.ResourcePoolDeploymentSpec.storage-profile-id requires System.Read. - The resource Datastore referenced by the attribute LibraryItem.ResourcePoolDeploymentSpec.default-datastore-id requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItem.DeploymentTarget.resource-pool-id requires VApp.Import. - The resource Folder referenced by the attribute LibraryItem.DeploymentTarget.folder-id requires VApp.Import.
POST
Filter Ovf Library Item Id
Queries an OVF package stored in content library to retrieve information to use when deploying the package. See LibraryItem.deploy. This operation retrieves information from the descriptor of the OVF package stored in the library item specified by ovfLibraryItemId. The information returned by the operation can be used to populate the deployment specification (see LibraryItem.ResourcePoolDeploymentSpec when deploying the OVF package to the deployment target specified by target. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter ovfLibraryItemId requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItem.DeploymentTarget.resource-pool-id requires System.Read. - The resource HostSystem referenced by the attribute LibraryItem.DeploymentTarget.host-id requires System.Read. - The resource Folder referenced by the attribute LibraryItem.DeploymentTarget.folder-id requires System.Read.
Probe Import Session
POST
Create Probe Import Session Ovf Probe Import Session Internal
Creates a probe import session. This can be used for inspecting various instantiation parameters using ProbeImportSession.try-instantiate. This operation is idempotent. Two calls with the same client token will result in the same session. 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 attribute ImportSession.CreateSpec.content-library-item requires System.Read.
DELETE
Delete Id Probe Import Session Internal
Deletes (or cancels) a probe import session. A client should terminate a session to free up resources on the server. A probe session will automatically be reclaimed after a period of inactivity. For example it will only remain in PROBE_IMPORT_ERROR state for a period of time. Deleting an already deleted session has no effect. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfProbeImportSession referenced by the parameter id requires System.Read.
GET
Get Id Probe Import Session Internal
Retrieves a probe import session. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfProbeImportSession referenced by the parameter id requires System.Read.
POST
Try Instantiate Id Internal
When a probe import session is in the PROBE_IMPORT_SELECTING_OVF_PARAMS state, this method returns information about instantiation parameters that can be specified for the probe session. The instantiation parameters returned depend on the choices specified in the instantiation parameters provided as input arguments. This method can be iteratively called with progressively more detailed instantiation parameters. The operation does not change the state of the probe session. The call must supply all instantiation parameters each time. They are not remembered from one invocation to the next. This also means that the operation is naturally idempotent. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.vcenter.OvfProbeImportSession referenced by the parameter id requires System.Read.
Services
Settings
Namespaces
POST
Create Namespaces Internal
Creates a namespace. Requires the SettingsStore.Manage privilege. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
List Namespaces Internal
Lists all the namespaces in Settings Service. System.Read privilege is required. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DELETE
Delete Namespace Internal
Deletes a namespace along with its associated item data. Requires the SettingsStore.Manage privilege. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Namespace Internal
Retrieves the details of the namespace. System.Read privilege is required. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PATCH
Update Namespace Internal
Update a namespace with a changing configuration. Requires the SettingsStore.Manage privilege. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Namespaces Items
GET
List Namespace Items Internal
Returns a map of item values corresponding to the keys in the namespace. The readPrivilege defined in the namespace is checked before the operation is initiated. If keys is not passed in, the entire map of KV pairs are returned. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PATCH
Update Namespace Items Internal
Put a map of key value pairs in the namespace. This overrides any existing key/value if they already exist in the namespace. The writePrivilege defined in the namespace is checked before the operation is initiated. When the value is not passed in the map items, the item in the namespace is deleted. When an empty (0 length) String, "", is passed in as the value, the value is set to "". Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Storage
Policies
POST
Check Compatibility Policy Policies
Returns datastore compatibility summary about a specific storage policy.
GET
List Storage Policies
Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter. These storage policies can be used for provisioning virtual machines or disks.
System
Announcements
POST
Create System Announcements Internal
Create a new announcement
GET
List System Announcements Internal
Return information about all the announcements in the system.
DELETE
Delete Announcement System Internal
Delete an announcement
GET
Get Announcement System Internal
Return information about a specific announcements in the system.
PUT
Set Announcement System Internal
Set announcement properties.
System Config
Ceip
GET
Get System Config Ceip Internal
Get CEIP (Customer Experience Improvement Program) value.
PUT
Set System Config Ceip Internal
Set CEIP (Customer Experience Improvement Program) value.
Deployment Type
GET
Get System Config Deployment Type
Get the type of the vCenter appliance.
POST
Create System Config Deployment Type
Reconfigure the type of the vCenter appliance.
Feature State
GET
Get System Config Feature State Internal
Returns the current status of feature state switches.
Psc Registration
GET
Get System Config Psc Registration
Get information of the PSC that this appliance is registered with.
POST
Create System Config Psc Registration
Repoint this vCenter Server appliance to a different external PSC.
Features Tech Preview
GET
Get System Config Features Tech Preview Internal
Returns the current status of all the feature switches in Tech Preview. mode. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PATCH
Update System Config Features Tech Preview Internal
Sets the status to enabled/disabled for the Tech Preview feature switches present in the input map. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Tag Associations
Tagging
Tags
VM
DELETE
Delete Tag Vm Internal
Deletes any existing associations of this tag with virtual machines. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
List Tags Vm Internal
Returns information about the tags that are associated with virtual machines on this vCenter Server, where the tags need to match VM.FilterSpec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Host
DELETE
Delete Tag Host Internal
Deletes any existing associations of this tag with hosts. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
List Tags Host Internal
Returns information about the tags that are associated with hosts on this vCenter Server, where the tags need to match Host.FilterSpec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Host Associations
POST
Add Tag Associations Internal
Attaches a tag to multiple hosts. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Tag Host Associations Internal
Lists all hosts that have this tag attached. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Remove Tag Associations Internal
Detaches a tag from multiple hosts. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Vm Associations
POST
Add Tag Associations Internal
Attaches a tag to multiple virtual machines. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Tag Vm Associations Internal
Lists all virtual machine that have this tag attached. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Remove Tag Associations Internal
Detaches a tag from multiple virtual machines. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Tokenservice
Topology
Nodes
GET
Get Node Topology
Retrieve details for a given identifier of the vCenter or Platform Services Controller node. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
GET
List Topology Nodes
Returns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
Trust
Subscriptions
POST
Add Trust Subscriptions Internal
Add a new subscription record into database. There are two possible situations for add. A. In the first case, the client is only interested in one VCTrust object and the VCTrust object has to exist in database. To make such a subscription, the client need to tell database which VCTrust object he is interested in. The GUID (VCTrust Id) field stands for that specific VCTrust and need to be specified. In this way, the client will only receive notification from that specified object changes. There is no limit on how many subscription an endpoint can add. B. In the second case, the client makes a subscription without a specified VCTrust object, which means the client is interested in every VCTrust object. Whenever the database changes (e.g add a new VCTrust, delete VCTrust, update...), the client gets notified. All the records in the database will not be deleted automatically. The only way to delete a record is to invoke delete API. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires Trust.Administer.
DELETE
Delete Subscription Internal
If the client is no longer interested in the subscription, it can delete it by invoking this API and specify the subscription id. The subscription id is returned to the endpoint when it was created. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires Trust.Administer.
GET
Get Subscription Internal
This API is used by client to request for detailed information of a specific susbcription. It is queried using subscription id. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
GET
List Trust Subscriptions Internal
List all the subscriptions that a client have. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
PATCH
Update Subscription Id Subscriptions Internal
This API is used by client to renew a subscription by extend the expiration time of its existing subscriptions. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires Trust.Administer.
Vc Trusts
POST
Create Trust Internal
Creates a new trust for domain in given spec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires Trust.Manage and Trust.Administer.
GET
List Trust Internal
Returns summary information for each trust of the local node. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
DELETE
Delete Domain Trust Vc Trusts Internal
Deletes a trust for given domain. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires Trust.Manage and Trust.Administer.
GET
Get Domain Trust Vc Trusts Internal
Retrieve trust for given domain. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
PATCH
Update Domain Trust Vc Trusts Internal
Update a trust for given domain with data in given UpdateSpec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - Operation execution requires Trust.Manage and Trust.Administer.
Trusted Infrastructure
Trust Authority Clusters
GET
Get Cluster Trusted Infrastructure Trust Authority Clusters
Get the result of the last Update operation which matches the cluster id. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the parameter cluster requires System.View.
GET
List Trusted Infrastructure Trust Authority Clusters
Returns a list of clusters for this vCenter instance which matches the TrustAuthorityClusters.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the attribute TrustAuthorityClusters.FilterSpec.cluster requires System.View.
PATCH
Update Cluster Async
Updates the state of a cluster.
Attestation Services
POST
Create Trusted Infrastructure Attestation Services
Registers a new Attestation Service instance in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ManageTrustedHosts.
DELETE
Delete Service Attestation
Removes a registered Attestation Service instance from this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ManageTrustedHosts.
GET
Get Service Attestation
Returns the detailed information about a registered Attestation Service instance in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts.
POST
Query Attestation Services
Returns detailed information about all registered Attestation Service instances in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts.
Kms Services
POST
Create Trusted Infrastructure Kms Services
Registers a Key Provider Service instance in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ManageTrustedHosts.
DELETE
Delete Service Kms
Removes a currently registered Key Provider Service instance from this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ManageTrustedHosts.
GET
Get Service Kms
Returns the detailed information about a registered Key Provider Service instance in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts.
POST
Query Kms Services
Returns basic information about all registered Key Provider Service instances in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts.
Trust Authority Clusters Consumer Principals
POST
Create Cluster Consumer Principals Async
Creates a profile with the specified connection information on all hosts from a Trust Authority Cluster.
DELETE
Delete Cluster Profile Consumer Principals Async
Removes the read-only policy configured on ESX for a specific principal.
GET
Get Cluster Profile Consumer Principals Async
Retrieve information for a specific profile.
POST
Query Cluster Consumer Principals Async
Lists all policies configured on a specific cluster.
Trust Authority Clusters Attestation Service Status
GET
Get Cluster Attestation Service Status Async
Return the Attestation service health in the given cluster.
Trust Authority Clusters Attestation Os Esx Base Images
DELETE
Delete Cluster Version Base Images Async
Remove a trusted ESX base image of each ESX in the cluster.
GET
Get Cluster Version Base Images Async
Get the trusted ESX base version details.
POST
Import From Imgdb Cluster Base Images Async
Import ESX metadata as a new trusted base image to each host in the cluster. Import a boot_imgdb.tgz file which contains metadata that describes a trusted ESX base image. A boot_imgdb.tgz file can be downloaded from a representative host.
GET
Get Cluster Base Images Async
Return a list of trusted ESX base images.
Trust Authority Clusters Attestation Tpm2 Ca Certificates
POST
Create Cluster Tpm2 Ca Certificates Async
Add a new TPM CA certificate on a cluster.
GET
Get Cluster Tpm2 Ca Certificates Async
Return a list of configured TPM CA certificates on a cluster.
DELETE
Delete Cluster Name Ca Certificates Async
Remove a TPM CA certificate on a cluster.
GET
Get Cluster Name Ca Certificates Async
Get the TPM CA certificate details on a cluster.
Trust Authority Clusters Attestation Tpm2 Endorsement Keys
POST
Create Cluster Tpm2 Endorsement Keys Async
Add a new TPM endorsement key on a cluster.
GET
Get Cluster Tpm2 Endorsement Keys Async
Return a list of configured TPM endorsement keys in a cluster.
DELETE
Delete Cluster Name Endorsement Keys Async
Remove a TPM endorsement key on a cluster.
GET
Get Cluster Name Endorsement Keys Async
Get the TPM endorsement key details on a cluster.
Trust Authority Clusters Attestation Tpm2 Settings
GET
Get Cluster Tpm2 Settings Async
Return the TPM 2.0 protocol settings.
PATCH
Update Cluster Tpm2 Settings Async
Set the TPM 2.0 protocol settings.
Trust Authority Clusters Kms Providers
POST
Create Cluster Kms Providers Async
Add a new Key Provider.
GET
Get Cluster Kms Providers Async
Return a list of summary of Key Providers.
DELETE
Delete Cluster Provider Async
Remove a Key Provider.
GET
Get Cluster Provider Async
Return information about a Key Provider.
PATCH
Update Cluster Provider Async
Update an existing Key Provider.
Trust Authority Clusters Kms Service Status
GET
Get Cluster Kms Service Status Async
Return the Key Provider Service health in the given cluster.
Trust Authority Clusters Kms Providers Client Certificate
POST
Create Cluster Provider Client Certificate Async
Generate a new self signed client certificate. Existing client certificate is overwritten. The key server will use this certificate to validate the client connection.
GET
Get Cluster Provider Client Certificate Async
Return the existing client certificate.
PATCH
Update Cluster Provider Client Certificate Async
Update the client certificate. The key server will use this certificate to validate the client connection. If a client certificate already exists, it will be replaced. An optional private key can be specified if the certificate has already been provisioned.
Trust Authority Clusters Kms Providers Credential
PUT
Set Cluster Provider Credential Async
Set the key server credential.
Trust Authority Clusters Kms Providers Current Peer Certificates
GET
Get Cluster Provider Peer Certs Current Async
Return the remote server certificates. Contacts the configured key servers and attempts to retrieve their certificates. These certificates might not yet be trusted. If the returned certificates are to be considered trustworthy, then it must be added to the list of trusted server certificates by adding to the certificates returned by TrustedPeerCertificates.get and invoking TrustedPeerCertificates.update with the updated list of certificates.
Trust Authority Clusters Kms Providers Trusted Peer Certificates
GET
Get Cluster Provider Peer Certs Trusted Async
Return the list of trusted server certificates.
PATCH
Update Cluster Provider Peer Certs Trusted Async
Update trusted server certificate(s). The client will use these certificates to validate the server connection. The existing list of trusted certificates will be overwritten. The client will not trust the server connection until a server certificate has been set.
Trust Authority Clusters Kms Providers Client Certificate Csr
POST
Create Cluster Provider Client Certificate Csr Async
Generate a certificate signing request (CSR) for the client certificate. This overwrites any existing CSR. The CSR will allow the certificate to be signed by a third party. Once the CSR is signed, certificate may be added as a client certificate. Calling the API repeatedly will result in a generating a new CSR each time.
GET
Get Cluster Provider Client Certificate Csr Async
Get existing certificate signing request (CSR) for the client certificate. The CSR will allow the certificate to be signed by a third party. Once the CSR is signed, certificate may be added as a client certificate.
Trust Authority Hosts Attestation
GET
Get Host Trusted Infrastructure Attestation
Returns the connection info about the Attestation Service running on the specified host. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource HostSystem referenced by the parameter host requires System.View.
POST
Create Trusted Infrastructure Trust Authority Hosts Attestation
Returns a list of the hosts running a Attestation Service matching the specified Attestation.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource HostSystem referenced by the attribute Attestation.FilterSpec.hosts requires System.View. - The resource ClusterComputeResource referenced by the attribute Attestation.FilterSpec.clusters requires System.View.
Trust Authority Hosts Kms
GET
Get Host Trusted Infrastructure Kms
Returns the connection info about the Key Provider Service running on the specified host. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource HostSystem referenced by the parameter host requires System.View.
POST
Query Trust Authority Hosts Kms
Returns a list of the hosts running a Key Provider Service matching the specified Kms.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource HostSystem referenced by the attribute Kms.FilterSpec.hosts requires System.View. - The resource ClusterComputeResource referenced by the attribute Kms.FilterSpec.clusters requires System.View.
Trusted Clusters Services Applied Config
DELETE
Delete Cluster Services Applied Config Async
Delete all Trust Authority Components configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Trust Authority Component configurations from any Trusted Hosts within the given cluster.
GET
Get Cluster Services Applied Config Async
Returns detailed information about the health of the applied Trust Authority Component configurations in the given cluster.
PATCH
Update Cluster Services Applied Config Async
Update all applied Trust Authority Component configuration on the given cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation. If the cluster is not a Trusted Cluster, the method will remove all Trust Authority Component configuration from the Trusted Hosts in the cluster, if such hosts are found.
Trusted Clusters Attestation Services
POST
Create Cluster Attestation Services Async
Configures the cluster to use a the given registered Attestation Service.
DELETE
Delete Cluster Service Async
Removes the Attestation Service instance from the configuration of the given cluster.
GET
Get Cluster Service Attestation
Returns detailed information about the given registered Attestation Service instance that is configured for the given cluster. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the parameter cluster requires System.View.
POST
Query Cluster Attestation Services
Returns the basic information about all configured Attestation Service instances used by this cluster. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the parameter cluster requires System.View.
Trusted Clusters Attestation Services Applied Config
DELETE
Delete Cluster Attestation Services Applied Config Async
Delete the Attestation Service configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Attestation Service configuration from any Trusted Hosts within the given cluster.
GET
Get Cluster Attestation Services Applied Config Async
Returns detailed information about the health of the specified Attestation Service configuration applied to the cluster with respect to the desired state.
PATCH
Update Cluster Attestation Services Applied Config Async
Update the applied Attestation Service configuration on the given Trusted Cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation.
POST
Query Cluster Attestation Services Applied Config Async
Returns basic information about the health of all Attestation Service configurations applied to the cluster with respect to the desired state.
Trusted Clusters Kms Services
POST
Create Cluster Kms Services Async
Configures the cluster to use a the given registered Key Provider Service.
DELETE
Delete Cluster Service Async
Removes the Key Provider Service instance from the configuration of the given cluster.
GET
Get Cluster Service Kms
Returns detailed information about the given Key Provider Service instance used by the given cluster. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the parameter cluster requires System.View.
POST
Query Cluster Kms Services
Returns basic information about all configured Key Provider Service instances used by this cluster. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the parameter cluster requires System.View.
Trusted Clusters Kms Services Applied Config
DELETE
Delete Cluster Kms Services Applied Config Async
Delete the Key Provider Service configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Key Provider Service configuration from any Trusted Hosts within the given cluster.
GET
Get Cluster Kms Services Applied Config Async
Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state.
PATCH
Update Cluster Kms Services Applied Config Async
Update the applied Key Provider Service configuration on the given Trusted Cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation.
POST
Query Cluster Kms Services Applied Config Async
Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state.
Vcenter
VM
POST
Clone Vm
Creates a virtual machine from an existing virtual machine. if you do not have all of the privileges described as follows: - The resource Datastore referenced by the attribute VM.DiskCloneSpec.datastore requires Datastore.AllocateSpace. - The resource Datastore referenced by the attribute VM.ClonePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Folder referenced by the attribute VM.ClonePlacementSpec.folder requires VirtualMachine.Inventory.CreateFromExisting. - The resource ResourcePool referenced by the attribute VM.ClonePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource VirtualMachine referenced by the attribute VM.CloneSpec.source requires VirtualMachine.Provisioning.Clone.
POST
Clone Vm Async
Creates a virtual machine from an existing virtual machine. if you do not have all of the privileges described as follows: - The resource Datastore referenced by the attribute VM.DiskCloneSpec.datastore requires Datastore.AllocateSpace. - The resource Datastore referenced by the attribute VM.ClonePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Folder referenced by the attribute VM.ClonePlacementSpec.folder requires VirtualMachine.Inventory.CreateFromExisting. - The resource ResourcePool referenced by the attribute VM.ClonePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource VirtualMachine referenced by the attribute VM.CloneSpec.source requires VirtualMachine.Provisioning.Clone.
POST
Create Vm
Creates a virtual machine. if you do not have all of the privileges described as follows: - The resource Folder referenced by the attribute VM.InventoryPlacementSpec.folder requires VirtualMachine.Inventory.Create. - The resource ResourcePool referenced by the attribute VM.ComputePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource Datastore referenced by the attribute VM.StoragePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Network referenced by the attribute Ethernet.BackingSpec.network requires Network.Assign.
GET
List Vm
Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec.
DELETE
Delete Vm
Deletes a virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete.
GET
Get Vm
Returns information about a virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires System.Read.
POST
Instant Clone Vm
Create an instant clone of an existing virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the attribute VM.InstantCloneSpec.source requires VirtualMachine.Provisioning.Clone and VirtualMachine.Inventory.CreateFromExisting. - The resource Folder referenced by the attribute VM.InstantClonePlacementSpec.folder requires VirtualMachine.Interact.PowerOn. - The resource ResourcePool referenced by the attribute VM.InstantClonePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource Datastore referenced by the attribute VM.InstantClonePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Network referenced by the attribute Ethernet.BackingSpec.network requires Network.Assign.
POST
Register Vm
Creates a virtual machine from existing virtual machine files on storage. if you do not have all of the privileges described as follows: - The resource Datastore referenced by the attribute VM.RegisterSpec.datastore requires System.Read. - The resource Folder referenced by the attribute VM.InventoryPlacementSpec.folder requires VirtualMachine.Inventory.Register. - The resource ResourcePool referenced by the attribute VM.ComputePlacementSpec.resource-pool requires Resource.AssignVMToPool.
POST
Relocate Vm
Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate. - The resource ResourcePool referenced by the attribute VM.RelocatePlacementSpec.resource-pool requires Resource.AssignVMToPool.
POST
Relocate Vm Async
Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate. - The resource ResourcePool referenced by the attribute VM.RelocatePlacementSpec.resource-pool requires Resource.AssignVMToPool.
POST
Unregister Vm
Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage. All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Unregister.
Cluster
GET
List Cluster
Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec.
GET
Get Cluster
Retrieves information about the cluster corresponding to cluster.
Datacenter
POST
Create Datacenter
Create a new datacenter in the vCenter inventory
GET
List Datacenter
Returns information about at most 1000 visible (subject to permission checks) datacenters in vCenter matching the Datacenter.FilterSpec.
DELETE
Delete Datacenter
Delete an empty datacenter from the vCenter Server
GET
Get Datacenter
Retrieves information about the datacenter corresponding to datacenter.
Datastore
GET
Get Datastore
Retrieves information about the datastore indicated by datastore.
GET
List Datastore
Returns information about at most 2500 visible (subject to permission checks) datastores in vCenter matching the Datastore.FilterSpec.
Deployment
GET
Get Deployment
Get the current status of the appliance deployment.
POST
Rollback Deployment
Rollback a failed appliance so it can be configured once again.
Host
POST
Create Host Connect
Connect to the host corresponding to host previously added to the vCenter server.
POST
Create Host
Add a new standalone host in the vCenter inventory. The newly connected host will be in connected state. The vCenter Server will verify the SSL certificate before adding the host to its inventory. In the case where the SSL certificate cannot be verified because the Certificate Authority is not recognized or the certificate is self signed, the vCenter Server will fall back to thumbprint verification mode as defined by Host.CreateSpec.ThumbprintVerification.
GET
List Host
Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.
DELETE
Delete Host
Remove a standalone host from the vCenter Server.
POST
Create Host Disconnect
Disconnect the host corresponding to host from the vCenter server
Resource Pool
POST
Create Resource Pool
Creates a resource pool. if you do not have all of the privileges described as follows: - The resource ResourcePool referenced by the attribute ResourcePool.CreateSpec.parent requires Resource.CreatePool.
GET
List Resource Pool
Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePool.FilterSpec.
DELETE
Delete Resource Pool
Deletes a resource pool.
GET
Get Resource Pool
Retrieves information about the resource pool indicated by resourcePool. if you do not have all of the privileges described as follows: - The resource ResourcePool referenced by the parameter resourcePool requires System.Read.
PATCH
Update Resource Pool
Updates the configuration of a resource pool. if you do not have all of the privileges described as follows: - The resource ResourcePool referenced by the parameter resourcePool requires Resource.EditPool.
Vcha
Capabilities
GET
Get Vcha Capabilities Internal
Gets the capabilities of the active node of a VCHA cluster.
Cluster
POST
Deploy Vcha Cluster Async
Prepares, clones, and configures a VCHA cluster.
POST
Failover Vcha Cluster Async
Initiates failover from the active vCenter node to the passive node. For forced failover, Active node immediately initiates a failover. This may result into a data loss after failover. For planned failover, Active node flushes all the state to the Passive node, waits for the flush to complete before causing a failover. After the failover, Passive node starts without any data loss. A failover is allowed only in the following cases: 1. Cluster's mode is enabled and all cluster members are present. 2. Cluster's mode is maintenance and all cluster members are present.
POST
Get Vcha Cluster
Retrieves the status of a VCHA cluster.
POST
Undeploy Vcha Cluster Async
Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance. Optionally, the passive and witness node virtual machines will be deleted only if VCHA was deployed using automatic deployment. The active node in the cluster continues to run as a standalone VCVA appliance after the destroy operation has been performed. If the VCHA cluster is in a transition state and not configured, then the VCHA cluster specific information is removed.
Operations
GET
Get Vcha Operations
Retrieves the current active and disabled operations of a VCHA cluster.
Cluster Active
POST
Get Cluster Active
Retrieves information about the active node of a VCHA cluster.
Cluster Deployment Type
GET
Get Vcha Cluster Deployment Type
Retrieves the deployment type of a VCHA cluster.
Cluster Mode
GET
Get Vcha Cluster Mode
Retrieves the current mode of a VCHA cluster.
PUT
Set Cluster Mode Async
Manipulates the mode of a VCHA Cluster. Following mode transitions are allowed: enabled -> disabled - Allowed only in healthy and degraded states. enabled -> maintenance - Allowed only in healthy state. disabled -> enabled - Allowed only in healthy state. maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version. maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version. All other transitions are not allowed. VCHA Cluster configuration remains intact in any of the cluster modes.
Vm
Data Sets
POST
Create Vm Data Sets Internal
Creates a new data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
List Vm Data Sets Internal
Lists the data sets of a virtual machine. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DELETE
Delete Vm Data Set Internal
Delete a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Vm Data Set Internal
Returns information describing a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PATCH
Update Vm Data Set Internal
Modifies the attributes of a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Hardware
GET
Get Vm Hardware
Returns the virtual hardware settings of a virtual machine.
PATCH
Update Vm Hardware
Updates the virtual hardware settings of a virtual machine.
POST
Create Vm Hardware Action Upgrade
Upgrades the virtual machine to a newer virtual hardware version.
Identity
Library Item
GET
Get Vm Library Item
Returns the information about the library item associated with the virtual machine.
Power
GET
Get Vm Power
Returns the power state information of a virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires System.Read.
POST
Create Vm Power Reset
Resets a powered-on virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Reset.
POST
Create Vm Power Start
Powers on a powered-off or suspended virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOn.
POST
Create Vm Power Stop
Powers off a powered-on or suspended virtual machine. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOff.
POST
Create Vm Power Suspend
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.
Tags
POST
Add Vm Tags Internal
Attaches tags to a virtual machine. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Vm Tags Internal
Lists all tags attached to the virtual machine. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Remove Vm Tags Internal
Detaches tags from a virtual machine. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Tools
GET
Get Vm Tools
Get the properties of VMware Tools.
PATCH
Update Vm Tools
Update the properties of VMware Tools.
POST
Upgrade Vm Tools
Begins the Tools upgrade process. To monitor the status of the Tools upgrade, clients should check the Tools status by calling Tools.get and examining Tools.Info.version-status and Tools.Info.run-state.
Data Sets Entries
DELETE
Delete Vm Data Set Key Vm Entries Internal
Deletes an entry in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Vm Data Set Key Vm Entries Internal
Gets the value of an entry in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PUT
Set Vm Data Set Key Vm Entries Internal
Sets an entry in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Delete Multiple Vm Data Set Internal
Deletes multiple entries from a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Get Multiple Vm Data Set Internal
Gets the value of multiple entries in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
List Vm Data Set Internal
Lists all entry keys in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PATCH
Update Vm Data Set Internal
Modifies entries in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
POST
Set Multiple Vm Data Set Internal
Sets multiple entries in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Guest Environment
POST
Get Vm Name Environment Internal
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. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
POST
List Vm Guest Environment Internal
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. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
Guest Local Filesystem
GET
Get Vm Guest Local Filesystem
Returns details of the local file systems in the guest operating system.
Guest Networking
GET
Get Vm Guest Networking
Returns information about the network configuration in the guest operating system.
Guest Power
GET
Get Vm Guest Power
Returns information about the guest operating system power state.
POST
Reboot Vm Guest Power
Issues a request to the guest operating system asking it to perform a reboot. This request returns immediately and does not wait for the guest operating system to complete the operation.
POST
Shutdown Vm Guest Power
Issues a request to the guest operating system asking it to perform a clean shutdown of all services. This request returns immediately and does not wait for the guest operating system to complete the operation.
POST
Standby Vm Guest Power
Issues a request to the guest operating system asking it to perform a suspend operation.
Guest Processes
POST
Create Vm Guest Processes Internal
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. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.
POST
Delete Vm Pid Processes Internal
Terminates a process in the guest OS. On Posix guests, the process is sent a TERM signal. If that doesn't terminate the process, a KILL signal is sent. A process may still be running if it's stuck. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.
POST
Get Vm Pid Processes Internal
Gets the status of a process running in the guest operating system, including those started by Processes.create that may have recently completed. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
POST
List Vm Guest Processes Internal
List the processes running in the guest operating system, plus those started by Processes.create that have recently completed. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
Guest Filesystem Directories
POST
Create Vm Filesystem Directories Internal
Creates a directory in the guest operating system. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Create Temporary Vm Filesystem Directories Internal
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. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Delete Vm Filesystem Directories Internal
Deletes a directory in the guest operating system. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Move Vm Filesystem Directories Internal
Renames a directory in the guest. Renames the directory, or copies and deletes the old contents as required by the underlying filsystem. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
Guest Filesystem Files
POST
Create Temporary Vm Filesystem Files Internal
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. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Delete Vm Path Files Internal
Deletes a file in the guest operating system . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Get Vm Path Files Internal
Returns information about a file or directory in the guest. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
POST
List Vm Filesystem Files Internal
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. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
POST
Move Vm Filesystem Files Internal
Renames a file in the guest. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
POST
Update Vm Filesystem Files Internal
Changes the file attributes of a specified file or directory inside the guest. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
Guest Filesystem Transfers
GET
Get Vm Guest Filesystem Internal
Initiates an operation to transfer a file from the guest. Obtains a URL to the file inside the guest to be transferred to the client. If the power state of the Virtual Machine is changed when the file transfer is in progress, or the Virtual Machine is migrated, then the transfer operation is aborted. In order to ensure a secure connection to the host when transferring a file using HTTPS, the X.509 certificate for the host must be used to authenticate the remote end of the connection. The certificate of the host that the virtual machine is running on can be retrieved using the following fields: XXX insert link to certificate in Host config XXX . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PUT
Set Vm Guest Filesystem Internal
Initiates an operation to transfer a file to the guest. Obtains a URL to the file inside the guest to be transferred from the client. The user should send a HTTP PUT request specifying the file content in the body of the request. Multiple PUT request cannot be sent to the URL simultaneously. URL will be invalidated after a successful PUT request is sent. If the power state of the Virtual Machine is changed when the file transfer is in progress, or the Virtual Machine is migrated, then the transfer operation is aborted. In order to ensure a secure connection to the host when transferring a file using HTTPS, the X.509 certificate for the host must be used to authenticate the remote end of the connection. The certificate of the host that the virtual machine is running on can be retrieved using the following fields: XXX insert link to certificate in Host config XXX . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Guest Networking Interfaces
GET
List Vm Guest Networking Interfaces
Returns information about the networking interfaces in the guest operating system.
Guest Networking Routes
GET
List Vm Guest Networking Routes
Returns information about network routing in the guest operating system.
Hardware Boot
GET
Get Vm Hardware Boot
Returns the boot-related settings of a virtual machine.
PATCH
Update Vm Hardware Boot
Updates the boot-related settings of a virtual machine.
Hardware Cdrom
POST
Create Vm Cdrom Hardware Connect
Connects a virtual CD-ROM device of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Cdrom.update operation may be used to configure the virtual CD-ROM device to start in the connected state when the virtual machine is powered on.
POST
Create Vm Hardware Cdrom
Adds a virtual CD-ROM device to the virtual machine.
GET
List Vm Hardware Cdrom
Returns commonly used information about the virtual CD-ROM devices belonging to the virtual machine.
DELETE
Delete Vm Cdrom Hardware
Removes a virtual CD-ROM device from the virtual machine.
GET
Get Vm Cdrom Hardware
Returns information about a virtual CD-ROM device.
PATCH
Update Vm Cdrom Hardware
Updates the configuration of a virtual CD-ROM device.
POST
Create Vm Cdrom Hardware Disconnect
Disconnects a virtual CD-ROM device of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the CD-ROM device is not connected to its backing resource. For a powered-off virtual machine, the Cdrom.update operation may be used to configure the virtual CD-ROM device to start in the disconnected state when the virtual machine is powered on.
Hardware Cpu
GET
Get Vm Hardware Cpu
Returns the CPU-related settings of a virtual machine.
PATCH
Update Vm Hardware Cpu
Updates the CPU-related settings of a virtual machine.
Hardware Disk
POST
Create Vm Hardware Disk
Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.
GET
List Vm Hardware Disk
Returns commonly used information about the virtual disks belonging to the virtual machine.
DELETE
Delete Vm Disk Hardware
Removes a virtual disk from the virtual machine. This operation does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.
GET
Get Vm Disk Hardware
Returns information about a virtual disk.
PATCH
Update Vm Disk Hardware
Updates the configuration of a virtual disk. An update operation can be used to detach the existing VMDK file and attach another VMDK file to the virtual machine.
Hardware Ethernet
POST
Create Vm Nic Ethernet Connect
Connects a virtual Ethernet adapter of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Ethernet.update operation may be used to configure the virtual Ethernet adapter to start in the connected state when the virtual machine is powered on.
POST
Create Vm Hardware Ethernet
Adds a virtual Ethernet adapter to the virtual machine.
GET
List Vm Hardware Ethernet
Returns commonly used information about the virtual Ethernet adapters belonging to the virtual machine.
DELETE
Delete Vm Nic Hardware Ethernet
Removes a virtual Ethernet adapter from the virtual machine.
GET
Get Vm Nic Hardware Ethernet
Returns information about a virtual Ethernet adapter.
PATCH
Update Vm Nic Hardware Ethernet
Updates the configuration of a virtual Ethernet adapter.
POST
Create Vm Nic Ethernet Disconnect
Disconnects a virtual Ethernet adapter of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the Ethernet adapter is not connected to its backing resource. For a powered-off virtual machine, the Ethernet.update operation may be used to configure the virtual Ethernet adapter to start in the disconnected state when the virtual machine is powered on.
Hardware Floppy
POST
Create Vm Floppy Hardware Connect
Connects a virtual floppy drive of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Floppy.update operation may be used to configure the virtual floppy drive to start in the connected state when the virtual machine is powered on.
POST
Create Vm Hardware Floppy
Adds a virtual floppy drive to the virtual machine.
GET
List Vm Hardware Floppy
Returns commonly used information about the virtual floppy drives belonging to the virtual machine.
DELETE
Delete Vm Floppy Hardware
Removes a virtual floppy drive from the virtual machine.
GET
Get Vm Floppy Hardware
Returns information about a virtual floppy drive.
PATCH
Update Vm Floppy Hardware
Updates the configuration of a virtual floppy drive.
POST
Create Vm Floppy Hardware Disconnect
Disconnects a virtual floppy drive of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the floppy drive is not connected to its backing resource. For a powered-off virtual machine, the Floppy.update operation may be used to configure the virtual floppy floppy to start in the disconnected state when the virtual machine is powered on.
Hardware Memory
GET
Get Vm Hardware Memory
Returns the memory-related settings of a virtual machine.
PATCH
Update Vm Hardware Memory
Updates the memory-related settings of a virtual machine.
Hardware Parallel
POST
Create Vm Port Parallel Connect
Connects a virtual parallel port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Parallel.update operation may be used to configure the virtual parallel port to start in the connected state when the virtual machine is powered on.
POST
Create Vm Hardware Parallel
Adds a virtual parallel port to the virtual machine.
GET
List Vm Hardware Parallel
Returns commonly used information about the virtual parallel ports belonging to the virtual machine.
DELETE
Delete Vm Port Hardware Parallel
Removes a virtual parallel port from the virtual machine.
GET
Get Vm Port Hardware Parallel
Returns information about a virtual parallel port.
PATCH
Update Vm Port Hardware Parallel
Updates the configuration of a virtual parallel port.
POST
Create Vm Port Parallel Disconnect
Disconnects a virtual parallel port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the parallel port is not connected to its backing. For a powered-off virtual machine, the Parallel.update operation may be used to configure the virtual parallel port to start in the disconnected state when the virtual machine is powered on.
Hardware Serial
POST
Create Vm Port Serial Connect
Connects a virtual serial port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Serial.update operation may be used to configure the virtual serial port to start in the connected state when the virtual machine is powered on.
POST
Create Vm Hardware Serial
Adds a virtual serial port to the virtual machine.
GET
List Vm Hardware Serial
Returns commonly used information about the virtual serial ports belonging to the virtual machine.
DELETE
Delete Vm Port Hardware Serial
Removes a virtual serial port from the virtual machine.
GET
Get Vm Port Hardware Serial
Returns information about a virtual serial port.
PATCH
Update Vm Port Hardware Serial
Updates the configuration of a virtual serial port.
POST
Create Vm Port Serial Disconnect
Disconnects a virtual serial port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the serial port is not connected to its backing. For a powered-off virtual machine, the Serial.update operation may be used to configure the virtual serial port to start in the disconnected state when the virtual machine is powered on.
Hardware Adapter Nvme
POST
Create Vm Hardware Adapter Nvme Internal
Adds a virtual NVMe adapter to the virtual machine. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
List Vm Hardware Adapter Nvme Internal
Returns commonly used information about the virtual NVMe adapters belonging to the virtual machine. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DELETE
Delete Vm Adapter Hardware Nvme Internal
Removes a virtual NVMe adapter from the virtual machine. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
Get Vm Adapter Hardware Nvme Internal
Returns information about a virtual NVMe adapter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Hardware Adapter Sata
POST
Create Vm Hardware Adapter Sata
Adds a virtual SATA adapter to the virtual machine.
GET
List Vm Hardware Adapter Sata
Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.
DELETE
Delete Vm Adapter Hardware Sata
Removes a virtual SATA adapter from the virtual machine.
GET
Get Vm Adapter Hardware Sata
Returns information about a virtual SATA adapter.
Hardware Adapter Scsi
POST
Create Vm Hardware Adapter Scsi
Adds a virtual SCSI adapter to the virtual machine.
GET
List Vm Hardware Adapter Scsi
Returns commonly used information about the virtual SCSI adapters belonging to the virtual machine.
DELETE
Delete Vm Adapter Hardware Scsi
Removes a virtual SCSI adapter from the virtual machine.
GET
Get Vm Adapter Hardware Scsi
Returns information about a virtual SCSI adapter.
PATCH
Update Vm Adapter Hardware Scsi
Updates the configuration of a virtual SCSI adapter.
Hardware Boot Device
GET
Get Vm Hardware Boot Device
Returns an ordered list of boot devices for the virtual machine. If the list is empty, the virtual machine uses a default boot sequence.
PUT
Set Vm Hardware Boot Device
Sets the virtual devices that will be used to boot the virtual machine. The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the list is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of Device.Entry for a given device type except ETHERNET in the list.
Storage Policy
GET
Get Vm Storage Policy
Returns Information about Storage Policy associated with a virtual machine's home directory and/or its virtual hard disks.
PATCH
Update Vm Storage Policy
Updates the storage policy configuration of a virtual machine and/or its associated virtual hard disks.
Storage Policy Compliance
POST
Check Vm Policy Compliance
Returns the storage policy Compliance Compliance.Info of a virtual machine after explicitly re-computing compliance check.
GET
Get Vm Storage Policy Compliance
Returns the cached storage policy compliance information of a virtual machine.
Tools Installer
POST
Connect Vm Tools Installer
Connects the VMware Tools CD installer as a CD-ROM for the guest operating system. On Windows guest operating systems with autorun, this should cause the installer to initiate the Tools installation which will need user input to complete. On other (non-Windows) guest operating systems this will make the Tools installation available, and a a user will need to do guest-specific actions. On Linux, this includes opening an archive and running the installer. To monitor the status of the Tools install, clients should check the Tools.Info.version-status and Tools.Info.run-state from Tools.get
POST
Disconnect Vm Tools Installer
Disconnect the VMware Tools installer CD image.
GET
Get Vm Tools Installer
Get information about the VMware Tools installer.
Vm Template
Library Items
POST
Create Vm Template Library Items
Creates a library item in content library from a virtual machine. This operation creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.Library referenced by the attribute LibraryItems.CreateSpec.library requires ContentLibrary.AddLibraryItem. - The resource VirtualMachine referenced by the attribute LibraryItems.CreateSpec.source-vm requires System.Read. - The resource Datastore referenced by the attribute LibraryItems.CreateSpecVmHomeStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecVmHomeStoragePolicy.policy requires System.Read. - The resource Datastore referenced by the attribute LibraryItems.CreateSpecDiskStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecDiskStoragePolicy.policy requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.CreateSpec.disk-storage-overrides requires System.Read. - The resource Folder referenced by the attribute LibraryItems.CreatePlacementSpec.folder requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItems.CreatePlacementSpec.resource-pool requires System.Read. - The resource HostSystem referenced by the attribute LibraryItems.CreatePlacementSpec.host requires System.Read. - The resource ClusterComputeResource referenced by the attribute LibraryItems.CreatePlacementSpec.cluster requires System.Read.
POST
Deploy Template Library Item Library Items
Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem. It uses the deployment specification in spec. If LibraryItems.DeploySpec.powered-on and/or LibraryItems.DeploySpec.guest-customization are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires VirtualMachine.Provisioning.DeployTemplate. - The resource Datastore referenced by the attribute LibraryItems.DeploySpecVmHomeStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecVmHomeStoragePolicy.policy requires System.Read. - The resource Datastore referenced by the attribute LibraryItems.DeploySpecDiskStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecDiskStoragePolicy.policy requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.DeploySpec.disk-storage-overrides requires System.Read. - The resource Folder referenced by the attribute LibraryItems.DeployPlacementSpec.folder requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItems.DeployPlacementSpec.resource-pool requires System.Read. - The resource HostSystem referenced by the attribute LibraryItems.DeployPlacementSpec.host requires System.Read. - The resource ClusterComputeResource referenced by the attribute LibraryItems.DeployPlacementSpec.cluster requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.nics requires System.Read. - The resource Network referenced by the attribute LibraryItems.EthernetUpdateSpec.network requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the attribute LibraryItems.HardwareCustomizationSpec.disks-to-remove requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.disks-to-update requires System.Read.
GET
Get Template Library Item Vm Template
Returns information about a virtual machine template contained in the library item specified by templateLibraryItem if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
Library Items Check Outs
POST
Check In Template Library Item Vm Check Outs
Checks in a virtual machine into the library item. This operation updates the library item to contain the virtual machine being checked in as a template. This template becomes the latest version of the library item. The previous virtual machine template contained in the library item is available as a backup and its information can be queried using the Versions service. At most one previous version of a virtual machine template is retained in the library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckInTemplate. - The resource VirtualMachine referenced by the parameter vm requires System.Read.
POST
Check Out Template Library Item Check Outs
Checks out a library item containing a virtual machine template. This operation makes a copy of the source virtual machine template contained in the library item as a virtual machine. The virtual machine is copied with the same storage specification as the source virtual machine template. Changes to the checked out virtual machine do not affect the virtual machine template contained in the library item. To save these changes back into the library item, CheckOuts.check-in the virtual machine. To discard the changes, CheckOuts.delete the virtual machine. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckOutTemplate. - The resource Folder referenced by the attribute CheckOuts.PlacementSpec.folder requires System.Read. - The resource ResourcePool referenced by the attribute CheckOuts.PlacementSpec.resource-pool requires System.Read. - The resource HostSystem referenced by the attribute CheckOuts.PlacementSpec.host requires System.Read. - The resource ClusterComputeResource referenced by the attribute CheckOuts.PlacementSpec.cluster requires System.Read.
DELETE
Delete Template Library Item Vm Vm Template Check Outs
Deletes the checked out virtual machine. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
GET
Get Template Library Item Vm Vm Template Check Outs
Returns the information about a checked out virtual machine. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read. - The resource VirtualMachine referenced by the parameter vm requires System.Read.
GET
List Template Library Item Vm Template Check Outs
Returns commonly used information about the virtual machines that are checked out of the library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
Library Items Versions
DELETE
Delete Template Library Item Version Vm Template
Deletes the virtual machine template contained in the library item at the specified version. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.DeleteLibraryItem. - The resource com.vmware.content.library.item.Version referenced by the parameter version requires System.Read.
GET
Get Template Library Item Version Vm Template
Returns information about the live version of a library item containing a virtual machine template. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read. - The resource com.vmware.content.library.item.Version referenced by the parameter version requires System.Read.
GET
List Template Library Item Vm Template Versions
Returns commonly used information about the live versions of a virtual machine template library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
POST
Rollback Template Library Item Version
Rollbacks a library item containing a virtual machine template to a previous version. The virtual machine template at the specified version becomes the latest virtual machine template with a new version identifier. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckInTemplate. - The resource com.vmware.content.library.item.Version referenced by the parameter version requires System.Read.
Vmwportal
Accounts
POST
Check Account Internal
Checks if given user account is entitled to download product binaries from the my.vmware.com portal. Call Accounts::list() to get all the entitlement accounts linked to given my.vmware.com user. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
GET
List Vmwportal Accounts Internal
Gets the list of Entitlement Accounts (EA) attached to the user account on the my.vmware.com portal. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.