ESX REST APIs Operations Index

All available ESX REST APIs Operations.

HCL

Compatibility Data

get	Get Compatibility Data Provides information about the compatibility data located on the vCenter Appliance. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.HardwareCompatibility.Read.
post	Update Compatibility Data Task Replaces the local compatibility data with the latest version found from VMware official source.

Reports

get	Get Reports Returns the location Reports.Location information for downloading a compatibility report. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.HardwareCompatibility.Read.

Hosts Compatibility Releases

get

List Hosts Compatibility Releases
Lists the locally available ESXi releases for a given host that can be used to generate a compatiblity report. Each host has its own list of supported releases depending on its current release. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.HardwareCompatibility.Read.

Hosts Compatibility Report

get	Get Hosts Compatibility Report Returns the last generated hardware compatibility report for the given host.
post	Create Hosts Compatibility Report Task Generates hardware compatibility report for a specified ESXi host against specific ESXi release. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Hosts

Software

get	Get Software Returns details about the current software specification applied to the host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Software Installed Components

get

List Software Installed Components
Returns the installed components on the host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Settings

Depots

post

Sync Depots Task
Syncs the metadata from the currently configured online or umds depots. If any umds depot is set, then metadata is downloaded from that depot else metadata is downloaded from the online depots. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Clusters Configuration

get	Get Clusters Configuration Get the cluster configuration and related metadata. The configuration returned by this API only contains the user-visible configuration properties available for a the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.
post	Apply Clusters Configuration Task
post	Check Compliance Clusters Configuration Task Check all the hosts in the cluster for compliance with the desired document.
post	Export Config Clusters Configuration This API will export the configuration associated with the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Export. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.
post	Import Config Clusters Configuration Task This API replaces the existing desired configuration of the cluster with the configuration provided in the input parameter document. The API will internally validate the input configuration against the configuration schema derived from the cluster software specification associated with the cluster. If the input configuration document passes validation, then it will be the desired configuration of the cluster. The result will specify whether the input document was import successfully. The result will also list the validation errors in case the import operation failed.
post	Precheck Clusters Configuration Task This API will perform precheck of the desired cluster configuration on each of the hosts in the cluster. The API will check against the desired image schema whether the desired configuration has added any requirements for the host to be put in maintenance mode or to be rebooted. The API will also invoke plugins provided by the configuration owner to detect if the host needs to be put in maintenance mode or to be rebooted. If any host needs to be put in maintenance mode or rebooted, prechecks will be performed at the cluster and host level. The result will specify the validation errors if the desired configuration is not valid on the host. If valid, the result will specify host impact of the desired configuration, and list the configurations that will change on applying the desired configuration. If host impact is maintenance mode or reboot, precheck results will also be specified in the result.
post	Validate Clusters Configuration Task

Clusters Depot Overrides

get	Get Clusters Depot Overrides Returns the information about currently configured depot overrides for a given cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.
post	Add Clusters Depot Overrides Adds a new depot override to the list of currently configured depot overrides for a given cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.
post	Remove Clusters Depot Overrides Removes a depot override from the list of currently configured depot overrides for a given cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.

Clusters Software

get	Get Clusters Software Returns the complete desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
post	Apply Clusters Software Task Applies the desired software document associated with the given cluster to hosts within the cluster. If commit field is set, it implies the minimum commit that the Software.apply operation should use, however if subsequent commits have been made to the desired state document the apply operation will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
post	Check Clusters Software Task Runs checks on the cluster before applying the desired software document across all hosts in the cluster. Checks if all hosts in the cluster are in a good state to be updated with the desired software document. If commit field is set it implies the minimum commit that the check operation should use, however if subsequent commits have been made to the desired state document the check operation will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
post	Export Clusters Software Exports the desired software specification document and/or image. This API will not export the solution section of the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
post	Scan Clusters Software Task Scans all the hosts in the cluster against the cluster's desired state. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
post	Stage Clusters Software Task Stages the desired software document associated with the given cluster to hosts within the cluster. If commit field is set, it implies the minimum commit that the Software.stage operation should use, however if subsequent commits have been made to the desired state document the stage operation will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Clusters Configuration Schema

get

Get Clusters Configuration Schema
Returns the configuration schema associated with the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

Clusters Configuration Reports Last Apply Result

get

Get Clusters Configuration Reports Last Apply Result
Returns the most recent available result of applying the configuration document to all hosts within the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

Clusters Configuration Reports Last Compliance Result

get

Get Clusters Configuration Reports Last Compliance Result
This API provides results from the last completed Check Compliance operation on the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

Clusters Configuration Reports Last Precheck Result

get

Get Clusters Configuration Reports Last Precheck Result
This API returns results from the last Precheck operation on the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

Clusters Configuration Reports Recent Tasks

get

Get Clusters Configuration Reports Recent Tasks
This API returns the IDs of the configuration tasks most recently executed on this cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

Clusters Enablement Configuration

get

Get Clusters Enablement Configuration
Returns whether the given cluster is managed using a desired configuration plaftorm. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

Clusters Enablement Software

get	Get Clusters Enablement Software Returns whether the given cluster is managed with a single software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.
post	Check Clusters Enablement Software Task Checks the possibility to manage the cluster with a single software specification.
put	Enable Clusters Enablement Software Task Enables the feature which manages the cluster with a single software specification.

Clusters Enablement Configuration Transition

get	Get Clusters Enablement Configuration Transition This API returns the current transition state of the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.
post	Cancel Clusters Enablement Configuration Transition This API cancels the workflow to transition the cluster to desired configuration platform. If the status of transition is STARTED, the associated state information will be deleted. Otherwise, cancel will not be allowed and the API will throw an error. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.
post	Check Eligibility Clusters Enablement Configuration Transition Task The API performs eligibility checks on the cluster to see if it can be transitioned to desired configuration management platform.
post	Enable Clusters Enablement Configuration Transition Task The API enables ConfigManager on the cluster. Before setting the desired configuration state, the API verifies the eligibility of the cluster to transition to desired configuration platform. The API then validates and sets the configuration draft as the desired configuration of the cluster, thus enabling ConfigManager. The API finally initiates remediation by invoking Apply. Apply is not invoked if the cluster is empty. The API does not wait for remediation to complete before returning. If any of the above step fails, the API will fail and result will contain descriptive error messages.
post	Export Config Clusters Enablement Configuration Transition This API will export configuration associated with the cluster generated as part of the transition workflow. The API will throw an error if the transition state is not STARTED. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Export. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.
post	Export Schema Clusters Enablement Configuration Transition This API will export schema associated with the cluster. The API will throw an error if the transition state is not STARTED. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Export. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.
post	Import From File Clusters Enablement Configuration Transition The API imports the desired configuration from a file. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.
post	Import From Host Clusters Enablement Configuration Transition Task The API imports the desired configuration from a reference host in the cluster. The API also adds host-specific and host-overrides from the other hosts in the cluster. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed.
post	Precheck Clusters Enablement Configuration Transition Task The API computes impact of transitioning the cluster to be managed by desired configuration platform. It also runs health checks to verify the cluster's health before transitioning. The API returns the impact on the hosts in the cluster and the result of health checks from the cluster and hosts. Health checks are run only if the host needs be rebooted or put in maintenanceMode.
post	Validate Config Clusters Enablement Configuration Transition Task The API validates the imported desired configuration against the schema and on the hosts with validation plugins. If the document is valid, the API will check all the hosts for compliance with the desired configuration. The API returns validation errors if the configuration is not valid on any of the host. If the configuration is valid, the API returns compliance information.

Clusters Policies Apply

get	Get Clusters Policies Apply Returns the configured policy that has been set for the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.
put	Set Clusters Policies Apply This API will set the configured policy specification for the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.

Clusters Policies Apply Effective

get

Get Clusters Policies Apply Effective
Returns the effective apply policy based on system defaults and what has been configured for the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.

Clusters Software Add On

get

Get Clusters Software Add On
Returns the desired OEM add-on specification for a given cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Clusters Software Base Image

get

Get Clusters Software Base Image
Returns the desired base-image specification set for given cluster if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Clusters Software Commits

get	Get Clusters Software Commits Returns the information about a specific commit. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Clusters Software Compliance

get

Get Clusters Software Compliance
Returns the compliance state for the cluster if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Clusters Software Components

get

List Clusters Software Components
Returns a list of components in the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

get

Get Clusters Software Components
Returns the component version for the given component in the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Clusters Software Drafts

get	List Clusters Software Drafts Returns information about the software drafts for the specified cluster that match the Drafts.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
post	Create Clusters Software Drafts Creates a new software draft from the desired document. It will be deleted, when the draft is committed successfully. If a desired document is missing, then this operation will create an empty draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
get	Get Clusters Software Drafts Returns the information about given software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
delete	Delete Clusters Software Drafts Deletes the software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
post	Commit Clusters Software Drafts Task Commits the specified draft as the desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
post	Scan Clusters Software Drafts Task Scans all the hosts in the cluster against the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
post	Validate Clusters Software Drafts Task Validates the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
post	Import Software Spec Clusters Software Drafts Imports the desired software specification as a new draft. If a desired document is missing, then this operation will create an empty draft except when the source type is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION, then NotFound error is reported. In addition, the exisiting draft will be overwritten when the source type is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Clusters Software Effective Components

get

List Clusters Software Effective Components
Returns the effective components for the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Clusters Software Hardware Support

get

Get Clusters Software Hardware Support
Returns a given cluster's Hardware Support Package (HSP) configuration. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Clusters Software Recommendations

get	Get Clusters Software Recommendations Returns Information about the most recent recommendation generation result. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
post	Generate Clusters Software Recommendations Task Generates recommended software image spec(s) based on current desired software spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Clusters Software Solutions

get	List Clusters Software Solutions Returns all solutions in the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
get	Get Clusters Software Solutions Returns components registered for the given solution in the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
put	Set Clusters Software Solutions Task Sets the components registered for the given solution in the desired software specification. The task will set only one solution specification at a time. Solution constraints would be validated with the current desired software specification before it is committed as new desired spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
delete	Delete Clusters Software Solutions Task Deletes the given solution from the desired software specification. The deletion will be validated along with the entire software specification before it is committed as new desired spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Clusters Software Drafts Software Add On

get	Get Clusters Software Drafts Software Add On Returns the OEM add-on specification in a software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
put	Set Clusters Software Drafts Software Add On Sets a new desired OEM add-on specification in the software draft. It will overwrite the existing desired OEM add-on specification if one already exists. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
delete	Delete Clusters Software Drafts Software Add On Deletes the desired OEM add-on specification in the software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Clusters Software Drafts Software Base Image

get

Get Clusters Software Drafts Software Base Image
Returns the base-image specification in a software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

put

Set Clusters Software Drafts Software Base Image
Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Clusters Software Drafts Software Components

get	List Clusters Software Drafts Software Components Returns the components that comprise the software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
patch	Update Clusters Software Drafts Software Components Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
get	Get Clusters Software Drafts Software Components Returns the component version for the given component in the software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
put	Set Clusters Software Drafts Software Components Set the component version for a given component in the software draft. This will overwrite any existing version for the given component. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
delete	Delete Clusters Software Drafts Software Components Deletes the given component from the software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Clusters Software Drafts Software Effective Components

get

List Clusters Software Drafts Software Effective Components
Returns the components that comprise the desired software state of the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Clusters Software Drafts Software Hardware Support

get	Get Clusters Software Drafts Software Hardware Support Returns a given cluster's working copy document Hardware Support Package (HSP) configuration. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
put	Set Clusters Software Drafts Software Hardware Support Replaces a given cluster's working copy document Hardware Support Package (HSP) configuration. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
delete	Delete Clusters Software Drafts Software Hardware Support Deletes a given cluster's working copy document Hardware Support Package (HSP) configuration. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Clusters Software Reports Apply Impact

get

Get Clusters Software Reports Apply Impact
Returns a summary of how hosts within the cluster will be impacted during an apply operation. The impact is generated from the compliance information obtained from Compliance.get if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareRemediation.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareRemediation.Read.

Clusters Software Reports Hardware Compatibility

get	Get Clusters Software Reports Hardware Compatibility Returns the HCL validation check summary. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.HardwareCompatibility.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.HardwareCompatibility.Read.
post	Check Clusters Software Reports Hardware Compatibility Task Initiates a Cluster HCL Validation check for a given cluster. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Clusters Software Reports Last Apply Result

get

Get Clusters Software Reports Last Apply Result
Returns the most recent available result of applying the desired software document to all hosts within the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareRemediation.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareRemediation.Read.

Clusters Software Reports Last Check Result

get

Get Clusters Software Reports Last Check Result
Returns the most recent available result of checks run on the cluster before the application of the desired software document to all hosts within the cluster. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareRemediation.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareRemediation.Read.

Clusters Software Reports Hardware Compatibility Details

get

Get Clusters Software Reports Hardware Compatibility Details
Returns the HCL validation check detailed results. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.HardwareCompatibility.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.HardwareCompatibility.Read.

Clusters Software Reports Hardware Compatibility Storage Device Overrides Compliance Status

patch

Update Clusters Software Reports Hardware Compatibility Storage Device Overrides Compliance Status Task
Updates the Compliance staus overrides for storage devices in a cluster. This operation also updates the existing CheckResult if any, based on the device reclassification specified in ComplianceStatus.UpdateSpec The storage device categorization based on the compliance status from the last check result will remain the same until a HardwareCompatibility.check operation is invoked.

Clusters Software Reports Hardware Compatibility Storage Device Overrides VCg Entries

patch

Update Clusters Software Reports Hardware Compatibility Storage Device Overrides VCg Entries Task
Updates the storage device VMware Compatibility Guide (VCG) product overrides for a cluster. This operation also updates the existing CheckResult if any, based on the additional information provided by the vcg product overrides for the devices. The storage device categorization based on the compliance status from the last check result will remain the same until a HardwareCompatibility.check operation is invoked.

Defaults Clusters Policies Apply

put	Set Defaults Clusters Policies Apply This API will set the configured policy specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write.
get	Get Defaults Clusters Policies Apply Returns the configured policy that has been set. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Defaults Clusters Policies Apply Effective

get	Get Defaults Clusters Policies Apply Effective Returns the effective apply policy based on system defaults and what has been configured. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Defaults Hosts Policies Apply

get	Get Defaults Hosts Policies Apply Returns the configured policy that has been set. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
put	Set Defaults Hosts Policies Apply This API will set the configured policy. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write.

Defaults Hosts Policies Apply Effective

get	Get Defaults Hosts Policies Apply Effective Returns the effective policy based on system defaults and what has been configured. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Depot Content Add Ons

get	List Depot Content Add Ons Returns a list of currently available OEM add-ons in the depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Depot Content Base Images

get	List Depot Content Base Images Returns a list of currently available base images in the depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Depot Content Components

get	List Depot Content Components Returns a list of currently available components in the depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Depot Content Add Ons Versions

get	Get Depot Content Add Ons Versions Returns information about a given OEM add-on version in the depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Depot Content Base Images Versions

get	Get Depot Content Base Images Versions Returns information about a given base-image version in the depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Depot Content Components Versions

get	Get Depot Content Components Versions Returns information about a given component version in the depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Depots Offline

get	List Depots Offline Returns currently imported offline software depots. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
delete	Delete Depots Offline The task-based Offline.delete operation removes content of an imported offline depot from vLCM completely. Note: The non task-based Offline.delete operation has been deprecated. It deletes only the record of depot from the list of imported offline software depots, instead of removing the depot's content from vLCM. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleDepots.Delete.
get	Get Depots Offline Gets the information about an imported offline software depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
delete	Delete Depots Offline Task The task-based Offline.delete operation removes content of an imported offline depot from vLCM completely. Note: The non task-based Offline.delete operation has been deprecated. It deletes only the record of depot from the list of imported offline software depots, instead of removing the depot's content from vLCM. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleDepots.Delete.
post	Create From Host Depots Offline Task Extract the current software specification applied to the host and import it into the depot. Returns details about the current software specification applied to the host. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
post	Create Depots Offline Task Imports a new offline software depot. This will also import the metadata and payloads from this offline depot. The returned task will fail and no offline depot would be created if there are any issues during import. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Depots Online

get	List Depots Online Returns a list of currently configured online software depots. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
post	Create Depots Online Adds a new online software depot to the list of currently configured online software depots. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write.
delete	Delete Depots Online The task-based Online.delete operation removes content of a user-imported online depot from vLCM completely. As a result, the URL of the user-imported online depot will also be removed. Note: 1. To remove content of system-defined online depots, use Online.flush operation. 2. The non task-based Online.delete operation has been deprecated. It only deletes the record of depot from the list of imported online software depots, instead of removing the depot's content from the system. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleDepots.Delete.
get	Get Depots Online Gets the information about a currently configured online software depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
patch	Update Depots Online Updates the configuration of a currently configured online software depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write.
post	Flush Depots Online Task The task-based Online.flush operation removes content of a system-defined online depot from vLCM completely. As a result, the system-defined online depot will be disabled. Note: To remove content of user-imported online depots, use the task-based Online.delete operation.
delete	Delete Depots Online Task The task-based Online.delete operation removes content of a user-imported online depot from vLCM completely. As a result, the URL of the user-imported online depot will also be removed. Note: 1. To remove content of system-defined online depots, use Online.flush operation. 2. The non task-based Online.delete operation has been deprecated. It only deletes the record of depot from the list of imported online software depots, instead of removing the depot's content from the system. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleDepots.Delete.

Depots Sync Schedule

get	Get Depots Sync Schedule Returns the currently configured software depot sync schedule. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
put	Set Depots Sync Schedule Sets the software depot sync schedule. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write.

Depots UMDs

get	Get Depots UMDs Gets the information about a currently configured UMDS software depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
put	Set Depots UMDs Sets or overwrites information about the UMDS software depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write.
patch	Update Depots UMDs Updates the configuration of a currently configured UMDS software depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write.
delete	Delete Depots UMDs The task-based Umds.delete operation removes content of the UMDS depot from vLCM completely. Note: The non task-based Umds.delete operation has been deprecated. It deletes only the record of UMDS depot from database, instead of removing the content of UMDS depot from vLCM. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleDepots.Delete.
delete	Delete Depots UMDs Task The task-based Umds.delete operation removes content of the UMDS depot from vLCM completely. Note: The non task-based Umds.delete operation has been deprecated. It deletes only the record of UMDS depot from database, instead of removing the content of UMDS depot from vLCM. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleDepots.Delete.

Depots Offline Content

get	Get Depots Offline Content Gets the information of content of an imported offline software depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Depots Online Content

get	Get Depots Online Content Gets the information of content of an imported online software depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Depots UMDs Content

get	Get Depots UMDs Content Gets the information of content about the UMDS depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Hardware Support Managers

get	List Hardware Support Managers Returns the list of registered Hardware Support Managers (HSMs) in the system. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Hardware Support Managers Packages

get

List Hardware Support Managers Packages
Returns the list of available Hardware Support Packages (HSPs) for a particular host, as specified by its Hardware Support Manager (HSM) if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Hardware Support Managers Packages Versions

get

Get Hardware Support Managers Packages Versions
Returns the detailed information for a specific version of an available Hardware Support Packages (HSPs) as specified by the Hardware Support Manager (HSM) if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.

Hosts Configuration

post

Extract Hosts Configuration
Extracts a configuration document from the ESXi host, if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.Modify. - The resource HostSystem referenced by the parameter host requires VcIntegrity.ClusterConfiguration.Modify.

Hosts Depot Overrides

get	Get Hosts Depot Overrides Returns the information about currently configured depot overrides for a given host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.
post	Add Hosts Depot Overrides Adds a new depot override to the list of currently configured depot overrides for a given host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.
post	Remove Hosts Depot Overrides Removes a depot override from the list of currently configured depot overrides for a given host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.

Hosts Software

get	Get Hosts Software Returns the complete desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
post	Apply Hosts Software Task Applies the desired software document associated with the given host. If commit field is set, it implies the minimum commit that the Software.apply operation should use, however if subsequent commits have been made to the desired state document the apply operation will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
post	Check Hosts Software Task Runs checks on the host before applying the desired software document. Checks if host is in a good state to be updated with the desired software document. If commit field is set it implies the minimum commit that the check operation should use, however if subsequent commits have been made to the desired state document the check operation will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
post	Export Hosts Software Exports the desired software specification document and/or image. This API will not export the solution section of the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
post	Scan Hosts Software Task Scans the host against the host's desired state.. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
post	Stage Hosts Software Task Stages the desired software document associated with the given host. If commit field is set, it implies the minimum commit that the Software.stage operation should use, however if subsequent commits have been made to the desired state document the stage operation will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Hosts Enablement Software

get	Get Hosts Enablement Software Returns whether the given standalone host is managed with a single software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.
post	Check Hosts Enablement Software Task Checks the possibility to manage the host with a single software specification.
put	Enable Hosts Enablement Software Task Enables the feature which manages the host with a single software specification.

Hosts Policies Apply

put	Set Hosts Policies Apply This API will set the configured policy for an ESXi host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.
get	Get Hosts Policies Apply Returns the configured policy that has been set for the ESXi host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.

Hosts Policies Apply Effective

get

Get Hosts Policies Apply Effective
Returns the effective policy based on system defaults and what has been configured for the ESXi host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.

Hosts Software Add On

get

Get Hosts Software Add On
Returns the desired OEM add-on specification for a given host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Hosts Software Base Image

get

Get Hosts Software Base Image
Returns the desired base-image specification set for given host if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Hosts Software Commits

get

Get Hosts Software Commits
Returns the information about a specific commit. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Hosts Software Compliance

get

Get Hosts Software Compliance
Returns the compliance state for the host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Hosts Software Components

get	List Hosts Software Components Returns a list of components in the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
get	Get Hosts Software Components Returns the component version for the given component in the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Hosts Software Drafts

get	List Hosts Software Drafts Returns information about the software drafts for the specified host that match the Drafts.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
post	Create Hosts Software Drafts Creates a new software draft from the desired document. It will be deleted, when the draft is committed successfully. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.
get	Get Hosts Software Drafts Returns the information about given software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
delete	Delete Hosts Software Drafts Deletes the software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.
post	Commit Hosts Software Drafts Task Commits the specified draft as the desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation. It will also validate the document before committing it.
post	Scan Hosts Software Drafts Task Scans the host against the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
post	Validate Hosts Software Drafts Task Validates the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
post	Import Software Spec Hosts Software Drafts Imports the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Hosts Software Effective Components

get

List Hosts Software Effective Components
Returns the effective components for the host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Hosts Software Recommendations

get	Get Hosts Software Recommendations Returns Information about the most recent recommendation generation result. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
post	Generate Hosts Software Recommendations Task Generates recommended software image spec(s) based on current desired software spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Hosts Software Solutions

get	List Hosts Software Solutions Returns all solutions in the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
get	Get Hosts Software Solutions Returns components registered for the given solution in the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
put	Set Hosts Software Solutions Task Sets the components registered for the given solution in the desired software specification. The task will set only one solution specification at a time. Solution constraints would be validated with the current desired software specification before it is committed as new desired spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
delete	Delete Hosts Software Solutions Task Deletes the given solution from the desired software specification. The deletion will be validated along with the entire software specification before it is committed as new desired spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Hosts Software Drafts Software Add On

delete	Delete Hosts Software Drafts Software Add On Deletes the desired OEM add-on specification in the software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.
get	Get Hosts Software Drafts Software Add On Returns the OEM add-on specification in a software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
put	Set Hosts Software Drafts Software Add On Sets a new desired OEM add-on specification in the software draft. It will overwrite the existing desired OEM add-on specification if one already exists. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Hosts Software Drafts Software Base Image

get

Get Hosts Software Drafts Software Base Image
Returns the base-image specification in a software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

put

Set Hosts Software Drafts Software Base Image
Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Hosts Software Drafts Software Components

get	List Hosts Software Drafts Software Components Returns the components that comprise the software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
patch	Update Hosts Software Drafts Software Components Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.
delete	Delete Hosts Software Drafts Software Components Deletes the given component from the software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.
get	Get Hosts Software Drafts Software Components Returns the component version for the given component in the software draft. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.
put	Set Hosts Software Drafts Software Components Set the component version for a given component in the software draft. This will overwrite any existing version for the given component. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Hosts Software Drafts Software Effective Components

get

List Hosts Software Drafts Software Effective Components
Returns the components that comprise the desired software state of the host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Hosts Software Reports Apply Impact

get

Get Hosts Software Reports Apply Impact
Returns a summary of how a standalone ESXi host will be impacted during an apply operation. The impact is generated from the compliance information obtained from Compliance.get if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareRemediation.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareRemediation.Read.

Hosts Software Reports Last Apply Result

get

Get Hosts Software Reports Last Apply Result
Returns the most recent available result of applying the desired software document to the standalone ESXi host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareRemediation.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareRemediation.Read.

Hosts Software Reports Last Check Result

get

Get Hosts Software Reports Last Check Result
Returns the most recent available result of checks run on the standalone host before the application of the desired software document to the host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareRemediation.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareRemediation.Read.

ESX REST APIs Operations Index

HCL

Hosts

Settings

Was this page helpful?