Editing a Draft Software Specification
After you have created a draft software specification, use the
vSphere
Automation
REST
API to edit its items. To set a base image to a draft software specification:
- For a cluster,use the.PUT https://request and submit the cluster and draft IDs as path parameters and a base image specification in the request body<vcenter_ip_address_or_fqdn>/api/esx/settings/clusters/<cluster_id>/software/drafts/<draft_id>/software/base-image
- For a standalone host,use the.PUT https://request and submit the host and draft IDs as path parameters and a base image specification in the request body<vcenter_ip_address_or_fqdn>/api/esx/settings/hosts/<host_id>/software/drafts/<draft_id>/software/base-image
If the draft contains a base image, this method overwrites the existing image. The base
image specification contains the version of the bootable
ESXi
that must be included in the desired state. To retrieve details
about the base image that is currently present in a draft, use the
. GET
https://
or <vcenter_ip_address_or_fqdn>
/api/esx/settings/clusters/<cluster_id>
/software/drafts/<draft_id>
/software/base-imageGET
https://
requests and submit as path parameters the cluster or the standalone host ID, and
the draft ID. You receive a <vcenter_ip_address_or_fqdn>
/api/esx/settings/hosts/<host_id>
/software/drafts/<draft_id>
/software/base-imageBaseImageInfo
JSON object in the
request body that holds the details about the version, display name and version, and
the release date of the ESXi
hostTo add an OEM add-on to a draft software specification:
- For a cluster,use the.PUT https://request<vcenter_ip_address_or_fqdn>/api/esx/settings/clusters/<cluster_id>/software/drafts/<draft_id>/software/add-on
- For a standalone host,use the.PUT https://request<vcenter_ip_address_or_fqdn>/api/esx/settings/hosts/<host_id>/software/drafts/<draft_id>/software/add-on
use the
. DELETE
https://
and <vcenter_ip_address_or_fqdn>
/api/esx/settings/clusters/<cluster_id>
/software/drafts/<draft_id>
/software/add-onDELETE
https://
and submit as path parameters the cluster or the standalone host ID, and the draft
ID<vcenter_ip_address_or_fqdn>
/api/esx/settings/hosts/<host_id>
/software/drafts/<draft_id>
/software/add-on You can add a component, change the version, or delete an existing component from a
draft software specification. To change the version of a component included in a draft:
- For a cluster,use the.PUT https://request<vcenter_ip_address_or_fqdn>/api/esx/settings/clusters/<cluster_id>/software/drafts/<draft_id>/software/components/<component_id>
- For a standalone host,use the.PUT https://request<vcenter_ip_address_or_fqdn>/api/esx/settings/hosts/<host_id>/software/drafts/<draft_id>/software/components/<component_id>
component_ID
and version
arguments to the
draft, if it is missing. To remove a component from a draft, use the
. You can change multiple components in a draft by DELETE
https://
and <vcenter_ip_address_or_fqdn>
/api/esx/settings/clusters/<cluster_id>
/software/drafts/<draft_id>
/software/components/<component_id>
DELETE
https://
requests<vcenter_ip_address_or_fqdn>
/api/esx/settings/hosts/<host_id>
/software/drafts/<draft_id>
/software/components/<component_id>
using the
.PATCH
https://
and <vcenter_ip_address_or_fqdn>
/api/esx/settings/clusters/<cluster_id>
/software/drafts/<draft_id>
/software/componentsPATCH
https://
requests. To specify the components you want to remove, add, or update for a given
draft, submit a cluster or a host <vcenter_ip_address_or_fqdn>
/api/esx/settings/hosts/<host_id>
/software/drafts/<draft_id>
/software/componentsComponents.UpdateSpec
JSON
object to the request body of the respective requestTo retrieve information about all components present in a draft, or a single component,
use the list requests of the respective
.Components
service