Settings APIs

Settings APIs

The esx settings package provides services to manage ESX settings.

API Categories
Configuration

The Configuration service provides operations to manage desired configuration of an ESX cluster.

AuditRecords

The AuditRecords service provides operations to get the auditing records of the configuration actions performed on a cluster in vCenter Server.

Drafts

The Drafts service provides operations to manage cluster configuration drafts.

LastApplyResult

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

LastComplianceResult

The LastComplianceResult service provides operations to get the last available check compliance result for the cluster.

LastPrecheckResult

The LastPrecheckResult service provides operations to get the most recent available result of Precheck.

RecentTasks

The RecentTasks service provides operations to get the most recent configuration-related tasks.

Schema

The Schema service provides operations to manage the desired configuration schema of an ESX cluster.

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.

Configuration

The Configuration service provides operations to control whether the cluster is managed using desired configuration platform semantics.

Transition

The Transition service provides operations to manage transition of an existing cluster to a desired configuration managed cluster.

Software

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

InstalledImages

The InstalledImages service provides operations to examine the software bundle running on group of ESXi hosts in a cluster

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.

Software

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

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.

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.

RemovedComponents

The RemovedComponents service provides operations to manage removal of components in a software draft.

EffectiveComponents

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

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.

RemovedComponents

The RemovedComponents service provides operations to manage removal of components in a software specification.

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.

Details

The Details service provides operations to retrieve selected results from a previously initiated HCL compliance scan.

ComplianceStatus

This service provides operations to manage hardware hardware compatibility overrides for storage devices.

VcgEntries

This service provides operations to manage VMware Compatibility Guide (VCG) product overrides for storage devices in a 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.

Solutions

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

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.

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.

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.

AddOns

The AddOns service provides operations to get OEM add-ons 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.

BaseImages

The BaseImages service provides operations to get base images 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.

Components

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

Versions

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

Depots

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

Offline

The Offline service provides operations to manage offline software depots used during ESX lifecycle management.

Content

The Content 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.

Content

The Content 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 the VMware vSphere Update Manager Download Service (UMDS) software depot used during ESX lifecycle management. This is the depot downloaded using UMDS. If the UMDS depot is specified, then online depots are ignored and data is downloaded only from the UMDS depot.

Content

The Content service provides operations to manage the UMDS depot used during ESX lifecycle management.

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.

Configuration

The Configuration service provides operations to manage configuration of a ESX host.

DepotOverrides

The DepotOverrides service provides operations to manage software depots overriden for a given host. In general ESX servers reach out to vCenter (VUM) to fetch the metadata and payloads required for lifecycle operations. But in ROBO environments ESX hosts can't (or because of bandwidth requirements shouldn't) reach out to vCenter to fetch payloads and metadata. This service allows setting host level overrides for depots. If any depots are provided for a host, then vCenter level depots are not used for that host'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 control whether the host 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 host.

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.

Software

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

AddOn

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

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 compliance results for a standalone host.

Components

The Components service provides operations to manage desired component specification for a standalone ESX host.

Drafts

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

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.

RemovedComponents

The RemovedComponents service provides operations to manage removal of components in a software draft.

EffectiveComponents

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

Recommendations

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

RemovedComponents

The RemovedComponents service provides operations to manage removal of components in a software draft.

ApplyImpact

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

LastApplyResult

The LastApplyResult service provides operations to get the most recent available result of applying the desired software document to a standalone ESXi host.

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.

Solutions

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