Scripting Object - VcImageLibraryManager

Scripting-object corresponding to
ImageLibraryManager
Attribute of
VcInternalServiceInstanceContent

Scripting Object Description

NOTE: This managed object type and all of its methods are experimental and subject to change in future releases.

This managed object type provides information about the Image Library servers that VirtualCenter Server is aware of.

Different types of Libraries can be registered with VirtualCenter, each using a different protocol for data exchange. As of now, VirtualCenter can communicate only with Virtual Infrastructure Image Library.

Libraries registered with VirtualCenter Server are listed in {@link vim.ServiceDirectory#service service}; if property {@link vim.ServiceDirectory.ServiceEndpoint#protocol protocol} for a service endpoint is set to {@link vim.ServiceDirectory.ServiceProtocol#viImageLibrary viImageLibrary}, then it is a library.

Clients can obtain a token to connect to a Library Server directly using {@link vim.SessionManager#acquireSessionTicket acquireSessionTicket}; the library {@link vim.ServiceDirectory.ServiceEndpoint#key key} must be provided as a parameter to that call.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, addLibrary, createTrigger, exportMediaToLibrary_Task, importLibraryMedia_Task, publishMediaToLibrary_Task, removeLibrary, updateLibrary

publishMediaToLibrary_Task

Publish media from datastore to Library. This method does not copy the contents of the media to the Library, but simply creates an entry that references this media.

Requires Datastore.FileManagement privilege on the source datastore. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcDatacenter

arg1String

arg2String

arg3VcImageLibraryManagerMediaInfo

arg4VcKeyValue []


Return Value

Type Description
VcTask

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

removeLibrary

Unregister an Image Library Server from VirtualCenter. Essentially removes the service entry from {@link vim.ServiceDirectory#service}.

@since vSphere API 4.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

exportMediaToLibrary_Task

Upload media from datastore to Library.

This method should be used to upload files from datastore, such as disk, floppy or ISO.

To upload OVF templates, {@link vim.OvfManager#exportOvfToUrl} must be used. Clients must first create an upload session with the Library, thus obtaining a base URL for PUT-ing files. This URL must be provided in the call to exportOvfToUrl. The latter method simply copies the files to the Library, but does not create an entry for it. Clients must publish the media with desired metadata to complete the OVF upload.

To export a customization profile, clients must first convert it to XML using {@link vim.CustomizationSpecManager#specItemToXml} and then directly upload (followed by publish) the result to the Library.

Requires Datastore.FileManagement privilege on the source datastore. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcDatacenter

arg1String

arg2String

arg3VcImageLibraryManagerMediaInfo

arg4VcKeyValue []


Return Value

Type Description
VcTask

updateLibrary

Update library information.

This method can be used to rename a library or replace the saved thumbprint of its SSL certificate. Updating the SSL thumprint may be required if the library certificate has changed since it was added to VirtualCenter Server. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1String

arg2String


Return Value

Type Description
None

importLibraryMedia_Task

Download media from Library into a datastore.

The destination of the downloaded media file(s) is indicated by the pair (datacenter, file-name). The file-name must be the full datastore-path of the destination file.

This method is recommended only for downloading disk, floppy and ISO media. Using it with customization profiles and OVFs will simply copy the files that make up the media to datastore.

To create a virtual machine from an OVF template, {@link vim.OvfManager#importOvfAtUrl} must be used, passing the URL of the OVF descriptor file as a parameter.

To import a customization profile, clients must download the media file directly from the Library and use it contents to create a profile with method {@link vim.CustomizationSpecManager#xmlToSpecItem}.

Requires Datastore.FileManagement privilege on the destination datastore. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1String

arg2VcKeyValue []

arg3VcDatacenter

arg4String

arg5Boolean


Return Value

Type Description
VcTask

addLibrary

Register an Image Library Server with VirtualCenter. Essentially adds a service entry to {@link vim.ServiceDirectory#service}.

@since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1String

arg2String


Return Value

Type Description
String