1. Types
  2. vcenter
  3. ovf

vcenter ovf: ovf file info

The ovf_file_info structure contains the information regarding a single file in an OVF package or an OVA package file.

Representation:

{
    "optional_upload" : true,
    "ssl_thumb_print" : "string",
    "bytes_transferred" : 1,
    "file_url" : "http://myurl.com",
    "size" : 1,
    "sha256" : "string",
    "file_type" : "OVF",
    "name" : "string",
    "upload_method" : "PUT"
}

Attributes:

Name Type Description
Required
name string Name of the file.

For files in the file reference section of the OVF this is the name defined in that section. For OVF descriptor, manifest or certificate files the server will assign a name.

If vcenter.ovf.ovf_file_info.file_type is OVA, this is will be an assigned name indicating the content that will be transferred from the OVA package file. For example, descriptor.ova refers to the OVF descriptor in the OVA file, message-bundle.ova refers to the message bundle files in the OVA file, disk-content.ova refers to all the disk content in the OVA file.
file_type string The type of file.

Indicates files that have special semantics in an OVF package, or indicates an OVA package file. Value is one of:
OVF: The file is an OVF descriptor.
MANIFEST: The file is a manifest.
CERT: The file is a certificate.
MSG_BUNDLE: A file with localized messages for the OVF.
DISK: The file is a disk.
CONTENT: Anything else a file that does not need special treatment during transfer.
OVA: The file is an OVA file.
NVRAM: The file is a NVRAM file for EFI boot support.
optional_upload boolean Indicates whether the file has to be supplied by the client. If this is a PUSH import, this field will be false if the client must upload the file to the URL specified in vcenter.ovf.ovf_file_info.file_url, and true if the client is not required to upload the file. If this is a PULL import or export, this field can be ignored.
size long The size of the file in bytes. This is the number of bytes to be transferred, which might not be the same as the logical size of the object represented by the underlying file.

It might not be known until the complete file has been transferred. In that case, the field is unset.

If vcenter.ovf.ovf_file_info.file_type is OVA, the size will be the total size of the files that are actually transferred from the OVA file. The transferred content are different at different state.
bytes_transferred long The number of transferred bytes.

When the file transfer is complete bytes_transferred will be equal to vcenter.ovf.ovf_file_info.size..

If vcenter.ovf.ovf_file_info.file_type is OVA, the transferred bytes will be the total transferred bytes of the files that are actually transferred from the OVA file.
sha256 string SHA-256 hash of the file contents.
Optional
file_url URI The location of the file.

When the OVF package is being imported by the client pushing files to the server (see Import#SourceType#PUSH_SOURCE) this is the URL that the client must upload to. If ImportSession#externalTransferSupported is true, the URL may be from external service. When the OVF package is being imported by the server pulling files (see {@link Import #SourceType#PULL_SOURCE}) this is the URL that the server will download from.

When this is an OVF package export, then it is the URL that the client is downloading from. For certain file types, such as FileType.MANIFEST, this URL will be unset until the file is ready for download.

Optional.

ssl_thumb_print string The SSL thumb print that is for the {@link OvfFileInfo #fileUrl} if required by it.

Optional.

upload_method string The HTTP method that can be used to upload file to the {@link OvfFileInfo #fileUrl} if it is an HTTP URL, PUT method should be used if it is unset.

Optional.