Settings APIs

Settings APIs

The esx settings package provides services to manage ESX settings.

API Categories
Depots

The Depots service provides operations to manage Software Depots used during ESX lifecycle management.

Configuration

The Configuration service provides operations to manage desired configuration of an ESX cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

DepotOverrides

The DepotOverrides service provides operations to manage software depots overriden for a given cluster. In general ESX servers reach out to vCenter (VUM) to fetch the metadata and payloads required for lifecycle operations. But in ROBO environments ESX clusters can't (or because of bandwidth requirements shouldn't) reach out to vCenter to fetch payloads and metadata. This service allows setting cluster level overrides for depots. If any depots are provided for a cluster, then vCenter level depots are not used for that cluster's remediation. These are not synced periodically at vCenter and are only used by ESXs for lifecycle operations.

Software

The Software service provides operations to manage desired software specification of an ESX cluster.

LastApplyResult

The LastApplyResult service provides operations to get the most recent available result of applying the configuration to all hosts within a cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Software

The Software service provides operations to control whether the cluster is managed with a single software specification.

Apply

The Apply service provides operations to configure the policies that will impact how the software and configuration specification documents are applied to an ESXi cluster.

Effective

The Effective service provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to an ESXi cluster.

ResetInfo

The ResetInfo service provides internal operations to identify the outcome when configured policies Apply.ConfiguredPolicySpec are reset. Note: This service is restricted for VMware internal use only.

AddOn

The AddOn service provides operations to manage desired OEM add-on specification for a given cluster.

BaseImage

The BaseImage service provides operations to manage desired ESX base image.

Commits

The Commits service provides operations to manage committed changes to desired software document.

Compliance

The Compliance service provides operations to get the last software compliance result for an ESX cluster.

Components

The Components service provides operations to get desired component specification for an ESX cluster.

Drafts

The Drafts service provides operations to manage working copy of software documents.

DraftsInternal

The Drafts service provides internal operations to manage working copy of software documents. Note: This service is restricted for VMware internal use only.

EffectiveComponents

The EffectiveComponents service provides operations to get effective list of components.

HaInternal

The HaInternal service provides operations to manage desired software state for HA solution on an ESX cluster. Note: This service is restricted for VMware internal use only.

HardwareSupport

The HardwareSupport service provides operations to manage a cluster's Hardware Support Package (HSP) configuration.

Recommendations

The Recommendations service provides operations to manage the generation and retrieval of recommended image specs.

Solutions

The Solutions service provides operations to manage desired software solution specifications for an ESX cluster.

SolutionsBeingAppliedInternal

The SolutionsBeingAppliedInternal service provides operations to manage software solution specification that is being considered to be applied. Note: This service is restricted for VMware internal use only.

AddOn

The AddOn service provides operations to manage the OEM add-on specification in a software draft.

BaseImage

The BaseImage service provides operations to manage the base-image specification in a software draft.

Components

The Components service provides operations to manage component specification in a software draft.

EffectiveComponents

The EffectiveComponents service provides operations to manage effective list of components.

HardwareSupport

The HardwareSupport service provides operations to manage a cluster's Hardware Support Package (HSP) configuration in working copy documents.

ApplyImpact

The ApplyImpact service provides operations to get the impact of an apply operation on a cluster.

HardwareCompatibility

The HardwareCompatibility service provides operations to manage HCL Validation of a software specification of an ESX cluster.

LastApplyResult

The LastApplyResult service provides operations to get the most recent available result of applying the desired software document to all hosts within a cluster.

LastCheckResult

The LastCheckResult service provides operations to get the most recent available result of the checks that have been run on a cluster before the application of the desired software document to all hosts within the cluster.

Details

The ComplianceStatus structure contains the possible different status of compliance with respect to target version.

SolutionsInternal

The SolutionsInternal service provides operations to manage a solution desired software specifications for an ESX cluster. Note: This service is restricted for VMware internal use only.

NsxInternal

The NsxInternal interface service provides operations to manage desired software state for the NSX solution on an ESX cluster. Note: This service is restricted for VMware internal use only.

Apply

The Apply service provides operations to configure the policies that will impact how the software and configuration specification documents are applied to ESXi clusters.

Effective

The Effective service provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to ESXi clusters.

ResetInfo

The ResetInfo service provides internal operations to identify the outcome when configured policies Apply.ConfiguredPolicySpec are reset. Note: This service is restricted for VMware internal use only.

Apply

The Apply service provides operations to configure the policies that will impact how the software and configuration specification documents are applied to ESXi hosts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Effective

The Effective service provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to ESXi hosts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

ResetInfo

The ResetInfo service provides internal operations to identify the outcome when configured policies Apply.ConfiguredPolicySpec are reset. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This service is restricted for VMware internal use only.

AddOns

The AddOns service provides operations to get OEM add-ons from the sync'ed and imported depots.

BaseImages

The BaseImages service provides operations to get base-images from the sync'ed and imported depots.

Components

The Components service provides operations to get Components from the sync'ed and imported depots.

Versions

The Versions service provides operations to get OEM add-on versions from the sync'ed and imported depots.

Versions

The Versions service provides operations to get versions of base-images from the sync'ed and imported depots.

Versions

The Versions service provides operations to get component versions from the sync'ed and imported depots.

Manifests

The Manifests service provides operations to get Hardware Support Package (HSP) manifests from the sync'ed and imported depots. Note: This service is restricted for VMware internal use only.

Versions

The Versions service provides operations to get Hardware Support Package (HSP) manifest versions from the sync'ed and imported depots. Note: This service is restricted for VMware internal use only.

Offline

The Offline service provides operations to manage Offline Software Depots used during ESX lifecycle management.

Online

The Online service provides operations to manage Online Software Depots used during ESX lifecycle management.

SyncSchedule

The SyncSchedule service provides operations to manage Schedule of Online Software Depot sync.

Umds

The Umds service provides operations to manage VMware vSphere Update Manager Download Service (UMDS) software depots used during ESX lifecycle management. This is the depot downloaded using UMDS. If a UMDS depot is specified then online depots are ignored and data is downloaded only from the UMDS depot.

Managers

The Managers service provides operations to list Hardware Support Manager (HSM) for a given vCenter.

Packages

The Packages service provides operations to manage a host's Hardware Support Package (HSP) configuration.

Versions

The Versions service provides operations to inspect a Hardware Support Package (HSP)'s detailed information.

Software

The Software service provides operations to manage desired software specification of a standalone ESX host.

Software

The Software service provides operations to control whether the host is managed with a single software specification. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Apply

The Apply service provides operations to configure the policies that will impact how the software and configuration specification documents are applied to an ESXi host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Effective

The Effective service provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to an ESXi host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

ResetInfo

The ResetInfo service provides internal operations to identify the outcome when configured policies Apply.ConfiguredPolicySpec are reset. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This service is restricted for VMware internal use only.

AddOn

The AddOn service provides operations to manage desired OEM add-on specification for a given standalone host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

BaseImage

The BaseImage service provides operations to manage desired ESX base image. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Commits

The Commits service provides operations to manage committed changes to desired software document. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Compliance

The Compliance service provides operations to get compliance results for a standalone host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Components

The Components service provides operations to manage desired component specification for a standalone ESX host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Drafts

The Drafts service provides operations to manage working copy of software documents. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

DraftsInternal

The Drafts service provides internal operations to manage working copy of software documents. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This service is restricted for VMware internal use only.

EffectiveComponents

The EffectiveComponents service provides operations to get effective list of components. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

HardwareSupport

The HardwareSupport service provides operations to manage a host's Hardware Support Package (HSP) configuration. Note: This service is restricted for VMware internal use only.

Solutions

The Solutions service provides operations to manage desired software solution specifications for an ESX host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

AddOn

The AddOn service provides operations to manage the OEM add-on specification in a software draft. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

BaseImage

The BaseImage service provides operations to manage the base-image specification in a software draft. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Components

The Components service provides operations to manage component specification in a software draft. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

EffectiveComponents

The EffectiveComponents service provides operations to manage effective list of components. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

HardwareSupport

The HardwareSupport service provides operations to manage a stand-alone host's Hardware Support Package (HSP) configuration in working copy documents. Note: This service is restricted for VMware internal use only.

ApplyImpact

The ApplyImpact service provides operations to get the impact of an apply operation on a standalone ESXi host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

LastApplyResult

The LastApplyResult service provides operations to get the most recent available result of applying the desired software document to a standalone ESXi host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

LastCheckResult

The LastCheckResult service provides operations to get the most recent available result of the checks that have been run on the standalone host before the application of the desired software document to the host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Software

The Software service provides operations to manage software documents for non-existing entities. Note: This service is restricted for VMware internal use only.

Summary

The Summary service provides operation to summarize the complaince result of the clusters in the data-center. Note: This service is restricted for VMware internal use only.