Esx Settings APIs
The com.vmware.esx.settings namespace provides resources to manage ESX settings.
The Esx Settings Clusters Configuration resource provides operations to manage desired configuration of an ESX cluster.
This resource was added in vSphere API 8.0.1.0.
The Esx Settings Clusters Configuration AuditRecords resource provides operations to get the auditing records of the configuration actions performed on a cluster in vCenter Server.
This resource was added in vSphere API 8.0.2.0.
The Esx Settings Clusters Configuration Drafts resource provides operations to manage cluster configuration drafts.
This resource was added in vSphere API 8.0.2.0.
The Esx Settings Clusters Configuration Reports LastApplyResult resource provides operations to get the most recent available result of applying the configuration to all hosts within a cluster.
This resource was added in vSphere API 8.0.1.0.
The Esx Settings Clusters Configuration Reports LastComplianceResult resource provides operations to get the last available check compliance result for the cluster.
This resource was added in vSphere API 8.0.1.0.
The Esx Settings Clusters Configuration Reports LastPrecheckResult resource provides operations to get the most recent available result of Precheck.
This resource was added in vSphere API 8.0.1.0.
The Esx Settings Clusters Configuration Reports RecentTasks resource provides operations to get the most recent configuration-related tasks.
This resource was added in vSphere API 8.0.1.0.
The Esx Settings Clusters Configuration Schema resource provides operations to manage the desired configuration schema of an ESX cluster.
This resource was added in vSphere API 8.0.1.0.
The Esx Settings Clusters DepotOverrides resource 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 resource 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.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Enablement Configuration resource provides operations to control whether the cluster is managed using desired configuration platform semantics.
This resource was added in vSphere API 8.0.1.0.
The Esx Settings Clusters Enablement Configuration Transition resource provides operations to manage transition of an existing cluster to a desired configuration managed cluster.
This resource was added in vSphere API 8.0.1.0.
The Esx Settings Clusters Enablement Software resource provides operations to control whether the cluster is managed with a single software specification.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters InstalledImages resource provides operations to examine the software bundle running on group of ESXi hosts in a cluster
This resource was added in vSphere API 8.0.3.0.
The Esx Settings Clusters Policies Apply resource provides operations to configure the policies that will impact how the software and configuration specification documents are applied to an ESXi cluster.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Policies Apply Effective resource provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to an ESXi cluster.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software resource provides operations to manage desired software specification of an ESX cluster.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software AddOn resource provides operations to manage desired OEM add-on specification for a given cluster.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software AlternativeImages resource provides operations to manage the alternative images for a given cluster.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software AlternativeImages DisplayName resource provides operations to manage the display name of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software AlternativeImages SelectionCriteria resource provides operations to manage the selection criteria of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software AlternativeImages Software resource provides operations to manage the desired software specification of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software AlternativeImages Software AddOn resource provides operations to manage the OEM add-on specification of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software AlternativeImages Software BaseImage resource provides operations to manage the base-image specification of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software AlternativeImages Software Components resource provides operations to manage component specification of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software AlternativeImages Software EffectiveComponents resource provides operations to manage effective list of components.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software AlternativeImages Software HardwareSupport resource provides operations to manage the Hardware Support Package (HSP) configuration of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software AlternativeImages Software RemovedComponents resource provides operations to manage removal of components in a software specification.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software AlternativeImages Software Solutions resource provides operations to manage desired software solution specifications for an ESX cluster.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software BaseImage resource provides operations to manage desired ESX base image.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Commits resource provides operations to manage committed changes to desired software document.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Compliance resource provides operations to get the last software compliance result for an ESX cluster.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Components resource provides operations to get desired component specification for an ESX cluster.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Drafts resource provides operations to manage working copy of software documents.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Drafts DisplayName resource provides operations to manage the display name in a cluster draft.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software Drafts Software AddOn resource provides operations to manage the OEM add-on specification in a software draft.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Drafts Software AlternativeImages resource provides operations to manage the alternative images of the draft.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software Drafts Software AlternativeImages DisplayName resource provides operations to manage the display name of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software Drafts Software AlternativeImages SelectionCriteria resource provides operations to configure the selection criteria of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software Drafts Software AlternativeImages Software AddOn resource provides operations to manage the OEM add-on specification of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software Drafts Software AlternativeImages Software BaseImage resource provides operations to manage the base-image specification of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software Drafts Software AlternativeImages Software Components resource provides operations to manage component specification of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software Drafts Software AlternativeImages Software EffectiveComponents resource provides operations to manage effective list of components.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software Drafts Software AlternativeImages Software HardwareSupport resource provides operations to manage the Hardware Support Package (HSP) configuration of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software Drafts Software AlternativeImages Software RemovedComponents resource provides operations to manage removal of components in a software draft.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software Drafts Software BaseImage resource provides operations to manage the base-image specification in a software draft.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Drafts Software Components resource provides operations to manage component specification in a software draft.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Drafts Software EffectiveComponents resource provides operations to manage effective list of components.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Drafts Software HardwareSupport resource provides operations to manage a cluster's Hardware Support Package (HSP) configuration in working copy documents.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Drafts Software RemovedComponents resource provides operations to manage removal of components in a software draft.
This resource was added in vSphere API 8.0.3.0.
The Esx Settings Clusters Software EffectiveComponents resource provides operations to get effective list of components.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software HardwareSupport resource provides operations to manage a cluster's Hardware Support Package (HSP) configuration.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Recommendations resource provides operations to manage the generation and retrieval of recommended image specs.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software RemovedComponents resource provides operations to manage removal of components in a software specification.
This resource was added in vSphere API 8.0.3.0.
The Esx Settings Clusters Software Reports ApplyImpact resource provides operations to get the impact of an apply operation on a cluster.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Reports HardwareCompatibility resource provides operations to manage HCL Validation of a software specification of an ESX cluster.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Reports HardwareCompatibility Details resource provides operations to retrieve selected results from a previously initiated HCL compliance scan.
This resource was added in vSphere API 7.0.0.0.
This resource provides operations to store and return information about local host hardware provided by the user.
This resource was added in vSphere API 7.0.3.0.
This resource provides operations to manage hardware hardware compatibility overrides for storage devices.
This resource was added in vSphere API 7.0.2.1.
This resource provides operations to manage Broadcom Compatibility Guide (BCG) product overrides for storage devices in a cluster.
This resource was added in vSphere API 7.0.2.1.
The Esx Settings Clusters Software Reports LastApplyResult resource provides operations to get the most recent available result of applying the desired software document to all hosts within a cluster.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software Reports LastCheckResult resource 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.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Software SoftwareSpecMetadata resource provides information about the software specification in the repository.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Software Solutions resource provides operations to manage desired software solution specifications for an ESX cluster.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Clusters Vms LifecycleHooks resource provides operations to read and process VM lifecycle hooks in an ESXi cluster. See Esx Settings Clusters Vms LifecycleHookInfo and Esx Settings Clusters Vms LifecycleHookConfig.
VM lifecycle hook workflow:
- A System VM solution configures hooks for the different lifecycle states of its VMs as part of a desired specification.
- The system starts a deployment of a VM for that solution.
- The VM reaches a lifecycle state for which a hook is configured in the desired specification of the solution.
- The system activates a hook that matches the lifecycle state of the VM and starts waiting for the solution to process this hook. Until the hook is not processed the system does not work actively to reach the desired state of the VM.
- The solution makes the necessary configurations related to the VM.
- The solution marks the hook as proccessed.
- The system continues working actively to reach the desired specification of the deployment
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Vms Solutions resource provides operations to manage the desired System VM solution specification of an ESXi cluster.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Clusters Vms Transition resource provides operations to manage the transition of a System VM solution desired solution specification from EAM to vLCM.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Defaults Clusters Policies Apply resource provides operations to configure the policies that will impact how the software and configuration specification documents are applied to ESXi clusters.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Defaults Clusters Policies Apply Effective resource provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to ESXi clusters.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Defaults Hosts Policies Apply resource provides operations to configure the policies that will impact how the software and configuration specification documents are applied to ESXi hosts.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Defaults Hosts Policies Apply Effective resource provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to ESXi hosts.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings DepotContent AddOns resource provides operations to get OEM add-ons from the sync'ed and imported depots.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings DepotContent AddOns Versions resource provides operations to get OEM add-on versions from the sync'ed and imported depots.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings DepotContent BaseImages resource provides operations to get base images from the sync'ed and imported depots.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings DepotContent BaseImages Versions resource provides operations to get versions of base images from the sync'ed and imported depots.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings DepotContent Components resource provides operations to get Components from the sync'ed and imported depots.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings DepotContent Components Versions resource provides operations to get component versions from the sync'ed and imported depots.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Depots resource provides operations to manage Software Depots used during ESX lifecycle management.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Depots Offline resource provides operations to manage offline software depots used during ESX lifecycle management.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Depots Offline Content resource provides operations to manage offline software depots used during ESX lifecycle management.
This resource was added in vSphere API 7.0.3.0.
The Esx Settings Depots Online resource provides operations to manage online software depots used during ESX lifecycle management.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Depots Online Content resource provides operations to manage online software depots used during ESX lifecycle management.
This resource was added in vSphere API 7.0.3.0.
The Esx Settings Depots SyncSchedule resource provides operations to manage Schedule of Online Software Depot sync.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Depots Umds resource 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.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Depots Umds Content resource provides operations to manage the UMDS depot used during ESX lifecycle management.
This resource was added in vSphere API 7.0.3.0.
The Esx Settings HardwareSupport Managers resource provides operations to list Hardware Support Manager (HSM) for a given vCenter.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings HardwareSupport Managers Packages resource provides operations to manage a host's Hardware Support Package (HSP) configuration.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings HardwareSupport Managers Packages Versions resource provides operations to inspect a Hardware Support Package (HSP)'s detailed information.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Hosts Configuration resource provides operations to manage configuration of a ESX host.
This resource was added in vSphere API 8.0.1.0.
The Esx Settings Hosts DepotOverrides resource 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 resource 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.
This resource was added in vSphere API 8.0.1.0.
The Esx Settings Hosts Enablement Software resource provides operations to control whether the host is managed with a single software specification.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Policies Apply resource provides operations to configure the policies that will impact how the software and configuration specification documents are applied to an ESXi host.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Policies Apply Effective resource provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to an ESXi host.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software resource provides operations to manage desired software specification of a standalone ESX host.
This resource was added in vSphere API 7.0.0.0.
The Esx Settings Hosts Software AddOn resource provides operations to manage desired OEM add-on specification for a given standalone host.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software BaseImage resource provides operations to manage desired ESX base image.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software Commits resource provides operations to manage committed changes to desired software document.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software Compliance resource provides operations to get compliance results for a standalone host.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software Components resource provides operations to manage desired component specification for a standalone ESX host.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software Drafts resource provides operations to manage working copy of software documents.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software Drafts DisplayName resource provides operations to manage the display name in a host draft.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Hosts Software Drafts Software AddOn resource provides operations to manage the OEM add-on specification in a software draft.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software Drafts Software BaseImage resource provides operations to manage the base-image specification in a software draft.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software Drafts Software Components resource provides operations to manage component specification in a software draft.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software Drafts Software EffectiveComponents resource provides operations to manage effective list of components.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software Drafts Software RemovedComponents resource provides operations to manage removal of components in a software draft.
This resource was added in vSphere API 8.0.3.0.
The Esx Settings Hosts Software EffectiveComponents resource provides operations to get effective list of components.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software Recommendations resource provides operations to manage the generation and retrieval of recommended image specs.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software RemovedComponents resource provides operations to manage removal of components in a software draft.
This resource was added in vSphere API 8.0.3.0.
The Esx Settings Hosts Software Reports ApplyImpact resource provides operations to get the impact of an apply operation on a standalone ESXi host.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software Reports LastApplyResult resource provides operations to get the most recent available result of applying the desired software document to a standalone ESXi host.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Hosts Software Reports LastCheckResult resource 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.
This resource was added in vSphere API 8.0.0.1.
The softwareSpecMetadata resource provides information about the software specification from the repository.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Hosts Software Solutions resource provides operations to manage desired software solution specifications for an ESX host.
This resource was added in vSphere API 8.0.0.1.
The Esx Settings Inventory resource defines operations that can be performed on entities belonging to vCenter's inventory.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Inventory Reports Summary Clusters resource provides operations summary report of clusters under given inventory.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Inventory Reports Summary Hosts resource provides operations summary report of standalone hosts under given inventory.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Inventory Reports TransitionSummary Clusters resource provides operations to fetch the installed image report and transition status for given clusters. The transition operation refers to transitioning a baseline managed entity to image managed entity.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Inventory Reports TransitionSummary Hosts resource provides operations to fetch the installed image report and transition status for standalone hosts. The transition operation refers to transitioning a baseline managed entity to image managed entity.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software resource provides operations to manage desired state software specifications in the repository.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software AlternativeImages EffectiveComponents resource provides operations to get effective list of components.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts resource provides operations to manage working copy of software specification in the repository.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts AddOn resource provides operations to manage the OEM add-on specification in a software draft.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts AlternativeImages resource provides operations to manage the alternative images of the draft.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts AlternativeImages AddOn resource provides operations to manage the OEM add-on specification of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts AlternativeImages BaseImage resource provides operations to manage the base-image specification of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts AlternativeImages Components resource provides operations to manage component specification of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts AlternativeImages DisplayName resource provides operations to manage the display name of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts AlternativeImages EffectiveComponents resource provides operations to manage effective list of components.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts AlternativeImages HardwareSupport resource provides operations to manage the Hardware Support Package (HSP) configuration of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts AlternativeImages RemovedComponents resource provides operations to manage removal of components in a software draft.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts AlternativeImages SelectionCriteria resource provides operations to configure the selection criteria of the alternative image.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts BaseImage resource provides operations to manage the base-image specification in a software draft.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts Components resource provides operations to manage component specification in a software draft.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts DisplayName resource provides operations to manage the display name in a software specification draft.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts EffectiveComponents resource provides operations to manage effective list of components.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts HardwareSupport resource provides operations to manage a softare specification's Hardware Support Package (HSP) configuration in working copy documents.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software Drafts RemovedComponents resource provides operations to manage removal of components in a software draft.
This resource was added in vSphere API 9.0.0.0.
The Esx Settings Repository Software EffectiveComponents resource provides operations to get effective list of components.
This resource was added in vSphere API 9.0.0.0.