Settings APIs
The esx settings package provides services to manage ESX settings.
The Depots service provides operations to manage Software Depots used during ESX lifecycle management.
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.
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.
The Software service provides operations to manage desired software specification of an ESX cluster.
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.
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.
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.
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.
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.
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.
The Software service provides operations to control whether the cluster is managed with a single software specification.
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.
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.
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.
The AddOn service provides operations to manage desired OEM add-on specification for a given cluster.
The BaseImage service provides operations to manage desired ESX base image.
The Commits service provides operations to manage committed changes to desired software document.
The Compliance service provides operations to get the last software compliance result for an ESX cluster.
The Components service provides operations to get desired component specification for an ESX cluster.
The Drafts service provides operations to manage working copy of software documents.
The EffectiveComponents service provides operations to get effective list of components.
The HardwareSupport service provides operations to manage a cluster's Hardware Support Package (HSP) configuration.
The Recommendations service provides operations to manage the generation and retrieval of recommended image specs.
The Solutions service provides operations to manage desired software solution specifications for an ESX cluster.
The AddOn service provides operations to manage the OEM add-on specification in a software draft.
The BaseImage service provides operations to manage the base-image specification in a software draft.
The Components service provides operations to manage component specification in a software draft.
The EffectiveComponents service provides operations to manage effective list of components.
The HardwareSupport service provides operations to manage a cluster's Hardware Support Package (HSP) configuration in working copy documents.
The ApplyImpact service provides operations to get the impact of an apply operation on a cluster.
The HardwareCompatibility service provides operations to manage HCL Validation of a software specification of an ESX cluster.
The LastApplyResult service provides operations to get the most recent available result of applying the desired software document to all hosts within a cluster.
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.
The Details service provides operations to retrieve selected results from a previously initiated HCL compliance scan.
This service provides operations to manage hardware hardware compatibility overrides for storage devices.
This service provides operations to manage VMware Compatibility Guide (VCG) product overrides for storage devices in a cluster.
The Apply service provides operations to configure the policies that will impact how the software and configuration specification documents are applied to ESXi clusters.
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.
The Apply service provides operations to configure the policies that will impact how the software and configuration specification documents are applied to ESXi hosts.
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.
The AddOns service provides operations to get OEM add-ons from the sync'ed and imported depots.
The BaseImages service provides operations to get base-images from the sync'ed and imported depots.
The Components service provides operations to get Components from the sync'ed and imported depots.
The Versions service provides operations to get OEM add-on versions from the sync'ed and imported depots.
The Versions service provides operations to get versions of base-images from the sync'ed and imported depots.
The Versions service provides operations to get component versions from the sync'ed and imported depots.
The Offline service provides operations to manage offline software depots used during ESX lifecycle management.
The Online service provides operations to manage online software depots used during ESX lifecycle management.
The SyncSchedule service provides operations to manage Schedule of Online Software Depot sync.
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.
The Content service provides operations to manage offline software depots used during ESX lifecycle management.
The Content service provides operations to manage online software depots used during ESX lifecycle management.
The Content service provides operations to manage the UMDS depot used during ESX lifecycle management.
The Managers service provides operations to list Hardware Support Manager (HSM) for a given vCenter.
The Packages service provides operations to manage a host's Hardware Support Package (HSP) configuration.
The Versions service provides operations to inspect a Hardware Support Package (HSP)'s detailed information.
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.
The Software service provides operations to manage desired software specification of a standalone ESX host.
The Software service provides operations to control whether the host is managed with a single software specification.
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.
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.
The AddOn service provides operations to manage desired OEM add-on specification for a given standalone host.
The BaseImage service provides operations to manage desired ESX base image.
The Commits service provides operations to manage committed changes to desired software document.
The Compliance service provides operations to get compliance results for a standalone host.
The Components service provides operations to manage desired component specification for a standalone ESX host.
The Drafts service provides operations to manage working copy of software documents.
The EffectiveComponents service provides operations to get effective list of components.
The Recommendations service provides operations to manage the generation and retrieval of recommended image specs.
The Solutions service provides operations to manage desired software solution specifications for an ESX host.
The AddOn service provides operations to manage the OEM add-on specification in a software draft.
The BaseImage service provides operations to manage the base-image specification in a software draft.
The Components service provides operations to manage component specification in a software draft.
The EffectiveComponents service provides operations to manage effective list of components.
The ApplyImpact service provides operations to get the impact of an apply operation on a standalone ESXi host.
The LastApplyResult service provides operations to get the most recent available result of applying the desired software document to a standalone ESXi host.
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.