Esx.Settings.Repository.Software.Drafts.ImportSpec

Esx.Settings.Repository.Software.Drafts.ImportSpec
Esx.Settings.Repository.Software.Drafts.ImportSpec

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

This schema was added in vSphere API 9.0.0.0.

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

Display name for the draft created.

This property was added in vSphere API 9.0.0.0.

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 #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.

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

This property was added in vSphere API 9.0.0.0.

string As uri As uri
location
Optional

Location of the software specification file to be imported.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of source_type is Esx.Settings.Repository.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 9.0.0.0.

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

string
software_spec
Optional

The JSON string representing the desired software specification.

This property was added in vSphere API 9.0.0.0.

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

boolean
delete_existing_draft
Optional

Deletes any existing draft by the user before creating a new draft, if deleteExistingDraft is set to TRUE.

This property was added in vSphere API 9.0.0.0.

If deleteExistingDraft is either unset of set to FALSE and there is already draft created by the user, an AlreadyExists exception is thrown.