Esx REST APIs Operations Index

Apply Cluster Configuration Async

Applies the cluster configuration associated with the cluster on the hosts associated with the cluster.

Check Compliance Cluster Configuration Async

Check all the hosts in the cluster for compliance with the desired document.

Export Config Cluster 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.

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

Import Config Cluster Configuration Async

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.

Precheck Cluster Configuration Async

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.

Validate Cluster Configuration Async

Check whether the desired cluster configuration is valid.

AuditRecords

List Cluster Configuration Audit Records

Retrieves audit information about the configuration actions performed 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.

Drafts

Apply Cluster Draft

Commit this draft and make it the new desired configuration for the cluster. The draft must be in the VALID state for this method to succeed. A successful commit will result in the draft being deleted. If the cluster is not empty, the Apply API will be called with the new desired state. if you do not have all of the privileges described as follows:

Operation execution requires VcIntegrity.ClusterConfiguration.Remediate.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Remediate.

Check Compliance Cluster Draft Async

Check all the hosts in the cluster for compliance with the configuration specified in the draft.

Create Cluster Configuration Drafts

Create a new draft with the given values. If a configuration is supplied in the spec, it will be used as the initial value. Otherwise, the current desired configuration will be used as the initial value. The Drafts.Metadata.owner field will be set to the caller's user ID and the Drafts.Metadata.parent-id will be set to the current commit ID for the cluster. 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.

List Cluster Configuration Drafts

Get the active drafts for 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.

Delete Cluster Draft Configuration

Delete this draft. Any changes will be abandoned. 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.

Get Cluster Draft Configuration

Get the cluster configuration and related metadata from this draft. 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.

Export Config Cluster Draft

This API will export the draft 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.

Get Cluster Draft

Get the differences between this draft and the current desired state for the cluster. 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.

Import From Host Cluster Draft Async

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.

Precheck Cluster Draft Async

This API will perform impact analysis of the configuration specified in the draft 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 which will validate the configuration on each hosts in the cluster. If the configuration is valid the API will also detect if the host needs to be maintenance mode or to be rebooted. If the hosts requires maintenance mode or reboot, then the API will run health checks to see the hosts can be put into the maintenance mode based on their current state. If any host cannot be put into maintenance mode due to health errors, then those errors will be reported in the result. The result will also list the configurations that will change on applying the configuration in the draft.

Get Cluster Draft

Get the differences between this draft and the current desired state for the cluster. 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.

Update Cluster Draft

Replace the current configuration in this draft with the supplied one. If the supplied configuration is different from the current value, the Drafts.Metadata.precheck-task fields will be cleared. If an expected revision number is provided, it must match the current revision of this draft or a ConcurrentChange exception will be raised. If no expected revision number is provided, this check will be skipped and the update will go through. 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.

LastApplyResult

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

LastComplianceResult

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

LastPrecheckResult

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

RecentTasks

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

Schema

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

DepotOverrides

Add Cluster Depot Overrides

Adds a new depot override to the list of currently configured depot overrides for a given cluster. Warning: Using HTTP is not secure. Please use HTTPS URLs instead.

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.

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

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

Configuration

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

Transition

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

Check Eligibility Cluster Configuration Transition Async

The API performs eligibility checks on the cluster to see if it can be transitioned to desired configuration management platform.

Enable Cluster Configuration Transition Async

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.

Export Config Cluster 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.

Export Schema Cluster 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.

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

Import From File Cluster 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.

Import From Host Cluster Configuration Transition Async

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.

Precheck Cluster Configuration Transition Async

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.

Validate Config Cluster Configuration Transition Async

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.

Software

Check Cluster Enablement Software Async

Checks the possibility to manage the cluster with a single software specification.

Set Cluster Enablement Software Async

Enables the feature which manages the cluster with a single software specification.

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

InstalledImages

Extract Cluster Installed Images Async

Extract installed images on all the hosts in the cluster. The API will work irrespective of whether a cluster is managed by single software image or not. If the cluster is not managed by single software image, it will first check the possibility to manage with single software image and if this check is successful then only it will extract the installed images on all the hosts. If the cluster is managed by single software image, it will skip eligibility check and directly extract the installed images on all the hosts.

Get Cluster Installed Images

Returns the last extracted installed Image info. 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.

Apply

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

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

Effective

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

Software

Apply Cluster Software Async

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.

Check Cluster Software Async

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.

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

Get Cluster Software

Returns the complete desired software specification. In case of Homogeneous Cluster, the specification will contain Default Image In case of Heterogeneous Cluster, the specification will contain Default Image + Alternative Images 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.

Scan Cluster Software Async

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.

Stage Cluster Software Async

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.

AddOn

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

BaseImage

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

Commits

Get Cluster Commit Software

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.

Compliance

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

Components

Get Cluster Component Software

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.

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

Drafts

Commit Cluster Draft Async

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.

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

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

Delete Cluster Draft Software

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.

Get Cluster Draft Software

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.

Import Software Spec Cluster 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. Warning: Using HTTP is not secure. Please use HTTPS URLs instead.

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.

Scan Cluster Draft Async

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.

Validate Cluster Draft Async

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.

AddOn

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

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

Set Cluster Draft 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.

BaseImage

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

Set Cluster Draft 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.

Components

Delete Cluster Draft Component Software

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.

Get Cluster Draft Component Software

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.

Set Cluster Draft Component Software

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.

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

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

EffectiveComponents

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

Get Cluster Draft Software Effective Components

Returns the list of all the effective components. Pass the param "with-removed-components" to get even the removed components. 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.

HardwareSupport

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

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

Set Cluster Draft 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.

RemovedComponents

Delete Cluster Draft Component Software Removed Components

Deletes the given component from the removed components section of 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.

Get Cluster Draft Component Software Removed Components

Returns the component information for the given removed 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.

Set Cluster Draft Component Software Removed Components

Set the component to be removed 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.

List Cluster Draft Software Removed Components

Returns the components that comprise the removed components section of 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.

EffectiveComponents

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

Get Cluster Software Effective Components

Returns the list of all the effective components. Pass the param "with-removed-components" to get even the removed components. 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.

HardwareSupport

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

Recommendations

Generate Cluster Software Recommendations Async

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.

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

RemovedComponents

Get Cluster Component Software Removed Components

Returns the component info for the given removed 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.

List Cluster Software Removed Components

Returns a map of removed 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.

ApplyImpact

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

HardwareCompatibility

Check Cluster Reports Hardware Compatibility Async

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.

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

Details

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

ComplianceStatus

Update Cluster Storage Device Overrides Compliance Status Async

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.

VcgEntries

Update Cluster Storage Device Overrides Vcg Entries Async

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.

LastApplyResult

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

LastCheckResult

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

Solutions

Delete Cluster Solution Async

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.

Set Cluster Solution Async

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.

Get Cluster Solution Software

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.

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

Apply

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.

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.

Effective

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

Apply

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.

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.

Effective

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

AddOns

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.

Versions

Get Name Version Add Ons

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.

BaseImages

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.

Versions

Get Version Base Images

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.

Components

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.

Versions

Get Name Version Components

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

Sync Depots Async

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.

Offline

Create From Host Depots Offline Async

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.

Create Depots Offline Async

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. Warning: Using HTTP is not secure. Please use HTTPS URLs instead.

Delete Depot 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 Depot 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 Depot Offline Async

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.

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.

Content

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

Online

Create Depots Online

Adds a new online software depot to the list of currently configured online software depots. Warning: Using HTTP is not secure. Please use HTTPS URLs instead.

if you do not have all of the privileges described as follows:

Operation execution requires VcIntegrity.lifecycleSettings.Write.

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.

Delete Depot 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:

To remove content of system-defined online depots, use Online.flush operation.
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 Depot 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.

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

Delete Depot Online Async

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:

To remove content of system-defined online depots, use Online.flush operation.
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.

Flush Depot Online Async

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.

Content

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

SyncSchedule

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.

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.

Umds

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.

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.

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.

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 Depots Umds Async

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.

Content

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.

Managers

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.

Packages

List Manager Hardware Support 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.

Versions

Get Manager Pkg Version Packages

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.

Configuration

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

DepotOverrides

Add Host Depot Overrides

Adds a new depot override to the list of currently configured depot overrides for a given host. Warning: Using HTTP is not secure. Please use HTTPS URLs instead.

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

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

Software

Check Host Enablement Software Async

Checks the possibility to manage the host with a single software specification.

Set Host Enablement Software Async

Enables the feature which manages the host with a single software specification.

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

Apply

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

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

Effective

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

Software

Apply Host Software Async

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.

Check Host Software Async

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.

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

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

Scan Host Software Async

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.

Stage Host Software Async

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.

AddOn

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

BaseImage

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

Commits

Get Host Commit Software

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.

Compliance

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

Components

Get Host Component Software

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.

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

Drafts

Commit Host Draft Async

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.

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

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

Delete Host Draft Software

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.

Get Host Draft Software

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.

Import Software Spec Host Software Drafts

Imports the desired software specification. Warning: Using HTTP is not secure. Please use HTTPS URLs instead.

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.

Scan Host Draft Async

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.

Validate Host Draft Async

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.

AddOn

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

Set Host Draft 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.

BaseImage

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

Set Host Draft 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.

Components

Delete Host Draft Component Software

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 Host Draft Component Software

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.

Set Host Draft Component Software

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.

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

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

EffectiveComponents

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

Get Host Draft Software Effective Components

Returns the list of all the effective components. Pass the param "with-removed-components" to get even the removed components. 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.

RemovedComponents

Delete Host Draft Component Software Removed Components

Deletes the given component from the removed component section of 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 Host Draft Component Software Removed Components

Returns the component information for the given removed 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.

Set Host Draft Component Software Removed Components

Set the component to be removed 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.

List Host Draft Software Removed Components

Returns the map of removed 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.

EffectiveComponents

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

Get Host Software Effective Components

Returns the list of all the effective components. Pass the param "with-removed-components" to get even the removed components. 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.

Recommendations

Generate Host Software Recommendations Async

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.

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

RemovedComponents

Get Host Component Software Removed Components

Returns the component version for the given removed 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.

List Host Software Removed Components

Returns a map of removed components in the desired software specification.

ApplyImpact

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

LastApplyResult

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

LastCheckResult

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

Solutions

Delete Host Solution Async

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.

Set Host Solution Async

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.

Get Host Solution Software

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.