Esx.Settings.Clusters.Vms.OvfResource

Esx.Settings.Clusters.Vms.OvfResource
Esx.Settings.Clusters.Vms.OvfResource

The Esx.Settings.Clusters.Vms.OvfResource schema contains properties that describe the location of an OVF package and a configuration for its download.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "location_type": "string",
    "url": "string",
    "ssl_certificate_validation": "string",
    "certificate": "string",
    "authentication_scheme": "string"
}
string
location_type
Required

Location type of OVF package.

Possible values:

  • REMOTE_FILE: The OVF package is hosted on a file server.
  • LOCAL_FILE: The OVF package is located on the local VC file system.

For more information see: Esx.Settings.Clusters.Vms.OvfResource.LocationType.

This property was added in vSphere API 9.0.0.0.

string As uri As uri
url
Optional

URL to the file server or the local VC file system where the OVF package can be downloaded. The supported URI schemes are http, https, and file.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of location_type is one of Esx.Settings.Clusters.Vms.OvfResource.LocationType.REMOTE_FILE or Esx.Settings.Clusters.Vms.OvfResource.LocationType.LOCAL_FILE.

string
ssl_certificate_validation
Optional

Configuration for SSL Certificate validation of the URL specified by the url.

Possible values:

  • ENABLED: The certificate must be fully validated by the system.
  • DISABLED: The certificate validation is disabled. The system trusts any certificate.

For more information see: Esx.Settings.Clusters.Vms.OvfResource.SslCertificateValidation.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of location_type is Esx.Settings.Clusters.Vms.OvfResource.LocationType.REMOTE_FILE.

string
certificate
Optional

The ssl certificate that is to be trusted by vLCM when downloading the OVF package from a file server.

This property was added in vSphere API 9.0.0.0.

If missing or null the system validates the file server certificate against the system trusted CAs.

string
authentication_scheme
Optional

The authentication scheme needed to access the OVF URL.

The supported schemes are listed in Esx.Settings.Clusters.Vms.AuthenticationScheme.

If the scheme is not missing or null and is not set to Esx.Settings.Clusters.Vms.AuthenticationScheme.NONE then Esx.Settings.Clusters.Vms.OvfResource.url must point to the VC.

Possible values:

  • NONE: Access doesn't require authentication.
  • VMWARE_SESSION_ID: Access requires VMware client sessionID.

For more information see: Esx.Settings.Clusters.Vms.AuthenticationScheme.

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.

If missing or null default value is Esx.Settings.Clusters.Vms.AuthenticationScheme.NONE.