Scripting Object - VcHostDatastoreBrowser

Scripting-object corresponding to
HostDatastoreBrowser
Attribute of
VcDatastore, VcEnvironmentBrowser, VcHostSystem

Scripting Object Description

The DatastoreBrowser managed object type provides access to the contents of one or more datastores. The items in a datastore are files that contain configuration, virtual disk, and the other data associated with a virtual machine.

Although datastores may often be implemented using a traditional file system, a full interface to a file system is not provided here. Instead, specialized access for virtual machine files is provided. A datastore implementation may completely hide the file directory structure.

The intent is to provide functionality analogous to a file chooser in a user interface.

Files on datastores do not have independent permissions through this API. Instead, the permissions for all the files on a datastore derive from the datastore object itself. It is not possible to change individual file permissions as the user browsing the datastore may not necessarily be a recognized user from the point of view of the host changing the permission. This occurs if the user browsing the datastore is doing so through the VirtualCenter management server.

The DatastoreBrowser provides many ways to customize a search for files. A search can be customized by specifying the types of files to be searched, search criteria specific to a file type, and the amount of detail about each file. The most basic queries only use file details and are efficient with limited side effects. For these queries, file metadata details can be optionally retrieved, but the files themselves are opened and their contents examined. As a result, these files are not necessarily validated.

More complicated queries can be formed by specifying the specific types of files to be searched, the parameters to filter for each type, and the desired level of detail about each file. This method of searching for files is convenient because it allows additional data about the virtual machine component to be retrieved. In addition, certain validation checks can be performed on matched files as an inherent part of the details collection process. However, gathering extra details or the use of type specific filters can sometimes only be implemented by examining the contents of a file. As a result, the use of these conveniences comes with the cost of additional latency in the request and possible side effects on the system as a whole.

The DatastoreBrowser is referenced from various objects, including from {@link vim.Datastore}, {@link vim.ComputeResource}, {@link vim.HostSystem} and {@link vim.VirtualMachine}. Depending on which object is used, there are different requirements for the accessibility of the browsed datastore from the host (or hosts) associated with the object:

Attributes

Name Type Description
datastoreVcDatastore []

@since VI API 2.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
supportedTypeVcFileQuery []

@since VI API 2.5
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, createTrigger, deleteFile, searchDatastore_Task, searchDatastoreSubFolders_Task

searchDatastore_Task

Returns the information for the files that match the given search criteria as a SearchResults object. Searches only the folder specified by the datastore path. The Datastore.Browse privilege must be held on the datastore identified by the datastore path. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostDatastoreBrowserSearchSpec


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

searchDatastoreSubFolders_Task

Returns the information for the files that match the given search criteria as a SearchResults[] object. Searches the folder specified by the datastore path and all subfolders. The Datastore.Browse privilege must be held on the datastore identified by the datastore path. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostDatastoreBrowserSearchSpec


Return Value

Type Description
VcTask

deleteFile

Deletes the specified files from the datastore. If a valid virtual disk file is specified, then all the components of the virtual disk are deleted. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None