Settings APIs
The esx settings package provides services to manage ESX settings.
Resources
Depots
The Depots service provides operations to manage Software Depots used during ESX lifecycle management.
Clusters
Configuration
The Configuration service provides operations to manage desired configuration of an ESX cluster. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Depot Overrides
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.
Clusters Configuration
Schema
The Schema service provides operations to manage the desired configuration schema of an ESX cluster. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Clusters Configuration Reports
Last Apply Result
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 available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Last Compliance Result
The LastComplianceResult service provides operations to get the last available check compliance result for the cluster. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Last Precheck Result
The LastPrecheckResult service provides operations to get the most recent available result of Precheck. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Recent Tasks
The RecentTasks service provides operations to get the most recent configuration-related tasks. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Clusters Enablement
Configuration
The Configuration service provides operations to control whether the cluster is managed using desired configuration platform semantics. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Software
The Software service provides operations to control whether the cluster is managed with a single software specification.
Clusters Enablement Configuration
Transition
The Transition service provides operations to manage transition of an existing cluster to a desired configuration managed cluster. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Clusters Policies
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.
Clusters Policies Apply
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.
Clusters Software
Add On
The AddOn service provides operations to manage desired OEM add-on specification for a given cluster.
Base Image
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.
Effective Components
The EffectiveComponents service provides operations to get effective list of components.
Hardware Support
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.
Clusters Software Drafts Software
Add On
The AddOn service provides operations to manage the OEM add-on specification in a software draft.
Base Image
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.
Effective Components
The EffectiveComponents service provides operations to manage effective list of components.
Hardware Support
The HardwareSupport service provides operations to manage a cluster’s Hardware Support Package (HSP) configuration in working copy documents.
Clusters Software Reports
Apply Impact
The ApplyImpact service provides operations to get the impact of an apply operation on a cluster.
Hardware Compatibility
The HardwareCompatibility service provides operations to manage HCL Validation of a software specification of an ESX cluster.
Last Apply Result
The LastApplyResult service provides operations to get the most recent available result of applying the desired software document to all hosts within a cluster.
Last Check Result
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.
Clusters Software Reports Hardware Compatibility
Details
The Details service provides operations to retrieve selected results from a previously initiated HCL compliance scan.
Clusters Software Reports Hardware Compatibility Storage Device Overrides
Compliance Status
This service provides operations to manage hardware hardware compatibility overrides for storage devices.
VCg Entries
This service provides operations to manage VMware Compatibility Guide (VCG) product overrides for storage devices in a cluster.
Defaults Clusters Policies
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.
Defaults Clusters Policies Apply
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.
Defaults Hosts Policies
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.
Defaults Hosts Policies Apply
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.
Depot Content
Add Ons
The AddOns service provides operations to get OEM add-ons from the sync’ed and imported depots.
Base Images
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.
Depot Content Add Ons
Versions
The Versions service provides operations to get OEM add-on versions from the sync’ed and imported depots.
Depot Content Base Images
Versions
The Versions service provides operations to get versions of base-images from the sync’ed and imported depots.
Depot Content Components
Versions
The Versions service provides operations to get component versions from the sync’ed and imported depots.
Depots
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.
Sync Schedule
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.
Depots Offline
Content
The Content service provides operations to manage offline software depots used during ESX lifecycle management.
Depots Online
Content
The Content service provides operations to manage online software depots used during ESX lifecycle management.
Depots UMDs
Content
The Content service provides operations to manage the UMDS depot used during ESX lifecycle management.
Hardware Support
Managers
The Managers service provides operations to list Hardware Support Manager (HSM) for a given vCenter.
Hardware Support Managers
Packages
The Packages service provides operations to manage a host’s Hardware Support Package (HSP) configuration.
Hardware Support Managers Packages
Versions
The Versions service provides operations to inspect a Hardware Support Package (HSP)’s detailed information.
Hosts
Configuration
The Configuration service provides operations to manage configuration of a ESX host. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Software
The Software service provides operations to manage desired software specification of a standalone ESX host.
Hosts Enablement
Software
The Software service provides operations to control whether the host is managed with a single software specification.
Hosts Policies
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.
Hosts Policies Apply
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.
Hosts Software
Add On
The AddOn service provides operations to manage desired OEM add-on specification for a given standalone host.
Base Image
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.
Effective Components
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.
Solutions
The Solutions service provides operations to manage desired software solution specifications for an ESX host.
Hosts Software Drafts Software
Add On
The AddOn service provides operations to manage the OEM add-on specification in a software draft.
Base Image
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.
Effective Components
The EffectiveComponents service provides operations to manage effective list of components.
Hosts Software Reports
Apply Impact
The ApplyImpact service provides operations to get the impact of an apply operation on a standalone ESXi host.
Last Apply Result
The LastApplyResult service provides operations to get the most recent available result of applying the desired software document to a standalone ESXi host.
Last Check Result
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.