Esx.Settings.Hosts.Software.Drafts.ImportSpec

Esx.Settings.Hosts.Software.Drafts.ImportSpec
Esx.Settings.Hosts.Software.Drafts.ImportSpec

The Esx.Settings.Hosts.Software.Drafts.ImportSpec schema defines the information used to import the desired software specification.

This schema was added in vSphere API 8.0.0.1.

JSON Example
{
    "source_type": "string",
    "location": "string",
    "file_id": "string",
    "software_spec": "string",
    "display_name": "string"
}
string
source_type
Required

Type of the source to import the desired software specification

Possible values:

  • PULL: Content is pulled from the URL location. The URL scheme of the value in {@link #pullLocation) can be http, https or file.
  • PUSH: Content was previously uploaded using the file upload endpoint present on vCenter appliance. This endpoint is present at https://VCENTERFQDN:9087/vum-fileupload URL.
  • JSON_STRING: The string representing the content of the software specification.
  • LATEST_RECOMMENDATION: Content is from recommended image specification based on latest base image version. Recommendations can be generated using POST /esx/settings/hosts/{host}/software/recommendations?action=generate.
  • CURRENT_SERIES_RECOMMENDATION: Content is from recommended image specification based on latest base image patch or update of the current series. For example, a host's current desired base image is 8.0. Recommendation engine will look into any recommendable image specification with 8.0 series base images available at depot manager and try to recommend the highest version within 8.0 series if possible. Let's say in this example, depot manager has 8.0 patch a and 8.0 update 1 base images. Recommendation engine would first validate all possible images based on 8.0 update 1. If it finds a valid one, it will store the recommended content with that series. This enum value will point to that stored recommended image content.

Recommendations can be generated using POST /esx/settings/hosts/{host}/software/recommendations?action=generate.

For more information see: Esx.Settings.Hosts.Software.Drafts.SourceType.

This property was added in vSphere API 8.0.0.1.

string As uri As uri
location
Optional

Location of the software specification file to be imported.

This property was added in vSphere API 8.0.0.1.

This property is optional and it is only relevant when the value of source_type is Esx.Settings.Hosts.Software.Drafts.SourceType.PULL.

string
file_id
Optional

File identifier returned by the file upload endpoint after file is uploaded.

This property was added in vSphere API 8.0.0.1.

This property is optional and it is only relevant when the value of source_type is Esx.Settings.Hosts.Software.Drafts.SourceType.PUSH.

string
software_spec
Optional

The JSON string representing the desired software specification.

This property was added in vSphere API 8.0.0.1.

This property is optional and it is only relevant when the value of source_type is Esx.Settings.Hosts.Software.Drafts.SourceType.JSON_STRING.

string
display_name
Optional

Display name of the desired software specification.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional because it was added in a newer version than its parent node.