public interface Files extends Service, FilesTypes
Files
interface provides methods to manage the files in the guest
filesystem. This interface was added in vSphere API 7.0.2.0.FilesTypes.FileAttributesInfo, FilesTypes.FileAttributesUpdateSpec, FilesTypes.FilesystemFamily, FilesTypes.FilterSpec, FilesTypes.Info, FilesTypes.IterationSpec, FilesTypes.LastIterationStatus, FilesTypes.ListResult, FilesTypes.PosixFileAttributesInfo, FilesTypes.PosixFileAttributesUpdateSpec, FilesTypes.Summary, FilesTypes.Type, FilesTypes.WindowsFileAttributesInfo, FilesTypes.WindowsFileAttributesUpdateSpec
_VAPI_SERVICE_ID
Modifier and Type | Method and Description |
---|---|
java.lang.String |
createTemporary(java.lang.String vm,
Credentials credentials,
java.lang.String prefix,
java.lang.String suffix,
java.lang.String parentPath)
Creates a temporary file.
|
void |
createTemporary(java.lang.String vm,
Credentials credentials,
java.lang.String prefix,
java.lang.String suffix,
java.lang.String parentPath,
AsyncCallback<java.lang.String> asyncCallback)
Creates a temporary file.
|
void |
createTemporary(java.lang.String vm,
Credentials credentials,
java.lang.String prefix,
java.lang.String suffix,
java.lang.String parentPath,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Creates a temporary file.
|
java.lang.String |
createTemporary(java.lang.String vm,
Credentials credentials,
java.lang.String prefix,
java.lang.String suffix,
java.lang.String parentPath,
InvocationConfig invocationConfig)
Creates a temporary file.
|
void |
delete(java.lang.String vm,
Credentials credentials,
java.lang.String path)
Deletes a file in the guest operating system
|
void |
delete(java.lang.String vm,
Credentials credentials,
java.lang.String path,
AsyncCallback<java.lang.Void> asyncCallback)
Deletes a file in the guest operating system
|
void |
delete(java.lang.String vm,
Credentials credentials,
java.lang.String path,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Deletes a file in the guest operating system
|
void |
delete(java.lang.String vm,
Credentials credentials,
java.lang.String path,
InvocationConfig invocationConfig)
Deletes a file in the guest operating system
|
FilesTypes.Info |
get(java.lang.String vm,
Credentials credentials,
java.lang.String path)
Returns information about a file or directory in the guest.
|
void |
get(java.lang.String vm,
Credentials credentials,
java.lang.String path,
AsyncCallback<FilesTypes.Info> asyncCallback)
Returns information about a file or directory in the guest.
|
void |
get(java.lang.String vm,
Credentials credentials,
java.lang.String path,
AsyncCallback<FilesTypes.Info> asyncCallback,
InvocationConfig invocationConfig)
Returns information about a file or directory in the guest.
|
FilesTypes.Info |
get(java.lang.String vm,
Credentials credentials,
java.lang.String path,
InvocationConfig invocationConfig)
Returns information about a file or directory in the guest.
|
FilesTypes.ListResult |
list(java.lang.String vm,
Credentials credentials,
java.lang.String path,
FilesTypes.IterationSpec iteration,
FilesTypes.FilterSpec filter)
Returns information about files and directories in the guest.
|
void |
list(java.lang.String vm,
Credentials credentials,
java.lang.String path,
FilesTypes.IterationSpec iteration,
FilesTypes.FilterSpec filter,
AsyncCallback<FilesTypes.ListResult> asyncCallback)
Returns information about files and directories in the guest.
|
void |
list(java.lang.String vm,
Credentials credentials,
java.lang.String path,
FilesTypes.IterationSpec iteration,
FilesTypes.FilterSpec filter,
AsyncCallback<FilesTypes.ListResult> asyncCallback,
InvocationConfig invocationConfig)
Returns information about files and directories in the guest.
|
FilesTypes.ListResult |
list(java.lang.String vm,
Credentials credentials,
java.lang.String path,
FilesTypes.IterationSpec iteration,
FilesTypes.FilterSpec filter,
InvocationConfig invocationConfig)
Returns information about files and directories in the guest.
|
void |
move(java.lang.String vm,
Credentials credentials,
java.lang.String path,
java.lang.String newPath,
java.lang.Boolean overwrite)
Renames a file in the guest.
|
void |
move(java.lang.String vm,
Credentials credentials,
java.lang.String path,
java.lang.String newPath,
java.lang.Boolean overwrite,
AsyncCallback<java.lang.Void> asyncCallback)
Renames a file in the guest.
|
void |
move(java.lang.String vm,
Credentials credentials,
java.lang.String path,
java.lang.String newPath,
java.lang.Boolean overwrite,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Renames a file in the guest.
|
void |
move(java.lang.String vm,
Credentials credentials,
java.lang.String path,
java.lang.String newPath,
java.lang.Boolean overwrite,
InvocationConfig invocationConfig)
Renames a file in the guest.
|
void |
update(java.lang.String vm,
Credentials credentials,
java.lang.String path,
FilesTypes.FileAttributesUpdateSpec fileAttributes)
Changes the file attributes of a specified file or directory inside the guest.
|
void |
update(java.lang.String vm,
Credentials credentials,
java.lang.String path,
FilesTypes.FileAttributesUpdateSpec fileAttributes,
AsyncCallback<java.lang.Void> asyncCallback)
Changes the file attributes of a specified file or directory inside the guest.
|
void |
update(java.lang.String vm,
Credentials credentials,
java.lang.String path,
FilesTypes.FileAttributesUpdateSpec fileAttributes,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Changes the file attributes of a specified file or directory inside the guest.
|
void |
update(java.lang.String vm,
Credentials credentials,
java.lang.String path,
FilesTypes.FileAttributesUpdateSpec fileAttributes,
InvocationConfig invocationConfig)
Changes the file attributes of a specified file or directory inside the guest.
|
void move(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.String newPath, java.lang.Boolean overwrite)
Synchronous method overload. Result of the invocation will be reported as a method return value.
vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the original file or symbolic link to be moved.newPath
- The complete path to the new file. It cannot be a path to an existing directory.overwrite
- If true, the destination file is overwritten.
If null
, the destination file is not overwritten.AlreadyExists
- if the newPath
already exists and overwrite
is false.InvalidArgument
- if path
is not a file. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.InvalidArgument
- if newPath
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotAllowedInCurrentState
- if the virtual machine not running.NotFound
- if the virtual machine is not found.NotFound
- if path
does not exist. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotFound
- if the parent directory of newPath
does not exist. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.ResourceBusy
- if the virtual machine is busy.ServiceUnavailable
- if the VMware Tools is not running.Unauthenticated
- if the credentials
object was not valid.Unauthorized
- if a path cannot be accessed.Unauthorized
- if a path cannot be renamed because the guest authentication will not allow the
operation.Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.Unauthorized
- if you do not have all of the privileges described as follows: VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. void move(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.String newPath, java.lang.Boolean overwrite, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the original file or symbolic link to be moved.newPath
- The complete path to the new file. It cannot be a path to an existing directory.overwrite
- If true, the destination file is overwritten.
If null
, the destination file is not overwritten.invocationConfig
- Configuration for the method invocation.AlreadyExists
- if the newPath
already exists and overwrite
is false.InvalidArgument
- if path
is not a file. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.InvalidArgument
- if newPath
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotAllowedInCurrentState
- if the virtual machine not running.NotFound
- if the virtual machine is not found.NotFound
- if path
does not exist. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotFound
- if the parent directory of newPath
does not exist. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.ResourceBusy
- if the virtual machine is busy.ServiceUnavailable
- if the VMware Tools is not running.Unauthenticated
- if the credentials
object was not valid.Unauthorized
- if a path cannot be accessed.Unauthorized
- if a path cannot be renamed because the guest authentication will not allow the
operation.Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.Unauthorized
- if you do not have all of the privileges described as follows: VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. void move(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.String newPath, java.lang.Boolean overwrite, AsyncCallback<java.lang.Void> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
AlreadyExists
- if the newPath
already exists and overwrite
is false.
InvalidArgument
- if path
is not a file. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
InvalidArgument
- if newPath
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotAllowedInCurrentState
- if the virtual machine not running.
NotFound
- if the virtual machine is not found.
NotFound
- if path
does not exist. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotFound
- if the parent directory of newPath
does not exist. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
ResourceBusy
- if the virtual machine is busy.
ServiceUnavailable
- if the VMware Tools is not running.
Unauthenticated
- if the credentials
object was not valid.
Unauthorized
- if a path cannot be accessed.
Unauthorized
- if a path cannot be renamed because the guest authentication will not allow the
operation.
Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.
Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the original file or symbolic link to be moved.newPath
- The complete path to the new file. It cannot be a path to an existing directory.overwrite
- If true, the destination file is overwritten.
If null
, the destination file is not overwritten.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void move(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.String newPath, java.lang.Boolean overwrite, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Operation Errors:
AlreadyExists
- if the newPath
already exists and overwrite
is false.
InvalidArgument
- if path
is not a file. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
InvalidArgument
- if newPath
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotAllowedInCurrentState
- if the virtual machine not running.
NotFound
- if the virtual machine is not found.
NotFound
- if path
does not exist. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotFound
- if the parent directory of newPath
does not exist. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
ResourceBusy
- if the virtual machine is busy.
ServiceUnavailable
- if the VMware Tools is not running.
Unauthenticated
- if the credentials
object was not valid.
Unauthorized
- if a path cannot be accessed.
Unauthorized
- if a path cannot be renamed because the guest authentication will not allow the
operation.
Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.
Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the original file or symbolic link to be moved.newPath
- The complete path to the new file. It cannot be a path to an existing directory.overwrite
- If true, the destination file is overwritten.
If null
, the destination file is not overwritten.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void update(java.lang.String vm, Credentials credentials, java.lang.String path, FilesTypes.FileAttributesUpdateSpec fileAttributes)
Synchronous method overload. Result of the invocation will be reported as a method return value.
vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the file or directory to be changed in the guest. If the
file points to an symbolic link, then the attributes of the target file are
changed.fileAttributes
- Specifies the different file attributes of the guest file to be changed. See
FilesTypes.FileAttributesUpdateSpec
.InvalidArgument
- if fileAttributes
does not apply to the guest operating system.InvalidArgument
- if path
is not a file. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotAllowedInCurrentState
- if the virtual machine is not running.NotFound
- if the virtual machine is not found.NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.ResourceBusy
- if the virtual machine is busy.ServiceUnavailable
- if the VMware Tools is not running.Unauthenticated
- if the credentials
object was not valid.Unauthorized
- if path
cannot be accessed.Unauthorized
- if path
cannot be updated because the guest authentication will not
allow the operation.Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.Unauthorized
- if you do not have all of the privileges described as follows: VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. void update(java.lang.String vm, Credentials credentials, java.lang.String path, FilesTypes.FileAttributesUpdateSpec fileAttributes, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the file or directory to be changed in the guest. If the
file points to an symbolic link, then the attributes of the target file are
changed.fileAttributes
- Specifies the different file attributes of the guest file to be changed. See
FilesTypes.FileAttributesUpdateSpec
.invocationConfig
- Configuration for the method invocation.InvalidArgument
- if fileAttributes
does not apply to the guest operating system.InvalidArgument
- if path
is not a file. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotAllowedInCurrentState
- if the virtual machine is not running.NotFound
- if the virtual machine is not found.NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.ResourceBusy
- if the virtual machine is busy.ServiceUnavailable
- if the VMware Tools is not running.Unauthenticated
- if the credentials
object was not valid.Unauthorized
- if path
cannot be accessed.Unauthorized
- if path
cannot be updated because the guest authentication will not
allow the operation.Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.Unauthorized
- if you do not have all of the privileges described as follows: VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. void update(java.lang.String vm, Credentials credentials, java.lang.String path, FilesTypes.FileAttributesUpdateSpec fileAttributes, AsyncCallback<java.lang.Void> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
InvalidArgument
- if fileAttributes
does not apply to the guest operating system.
InvalidArgument
- if path
is not a file. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotAllowedInCurrentState
- if the virtual machine is not running.
NotFound
- if the virtual machine is not found.
NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
ResourceBusy
- if the virtual machine is busy.
ServiceUnavailable
- if the VMware Tools is not running.
Unauthenticated
- if the credentials
object was not valid.
Unauthorized
- if path
cannot be accessed.
Unauthorized
- if path
cannot be updated because the guest authentication will not
allow the operation.
Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.
Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the file or directory to be changed in the guest. If the
file points to an symbolic link, then the attributes of the target file are
changed.fileAttributes
- Specifies the different file attributes of the guest file to be changed. See
FilesTypes.FileAttributesUpdateSpec
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void update(java.lang.String vm, Credentials credentials, java.lang.String path, FilesTypes.FileAttributesUpdateSpec fileAttributes, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Operation Errors:
InvalidArgument
- if fileAttributes
does not apply to the guest operating system.
InvalidArgument
- if path
is not a file. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotAllowedInCurrentState
- if the virtual machine is not running.
NotFound
- if the virtual machine is not found.
NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
ResourceBusy
- if the virtual machine is busy.
ServiceUnavailable
- if the VMware Tools is not running.
Unauthenticated
- if the credentials
object was not valid.
Unauthorized
- if path
cannot be accessed.
Unauthorized
- if path
cannot be updated because the guest authentication will not
allow the operation.
Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.
Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the file or directory to be changed in the guest. If the
file points to an symbolic link, then the attributes of the target file are
changed.fileAttributes
- Specifies the different file attributes of the guest file to be changed. See
FilesTypes.FileAttributesUpdateSpec
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void delete(java.lang.String vm, Credentials credentials, java.lang.String path)
Synchronous method overload. Result of the invocation will be reported as a method return value.
vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the file or symbolic link to be deleted.InvalidArgument
- if path
is not a file. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotAllowedInCurrentState
- if the virtual machine is not running.NotFound
- if the virtual machine is not found.NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.ResourceBusy
- if the virtual machine is busy.ServiceUnavailable
- if the VMware Tools is not running.Unauthenticated
- if the credentials
object was not valid.Unauthorized
- if path
cannot be accessed.Unauthorized
- if path
cannot be deleted because the guest authentication will not
allow the operation.Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.Unauthorized
- if you do not have all of the privileges described as follows: VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. void delete(java.lang.String vm, Credentials credentials, java.lang.String path, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the file or symbolic link to be deleted.invocationConfig
- Configuration for the method invocation.InvalidArgument
- if path
is not a file. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotAllowedInCurrentState
- if the virtual machine is not running.NotFound
- if the virtual machine is not found.NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.ResourceBusy
- if the virtual machine is busy.ServiceUnavailable
- if the VMware Tools is not running.Unauthenticated
- if the credentials
object was not valid.Unauthorized
- if path
cannot be accessed.Unauthorized
- if path
cannot be deleted because the guest authentication will not
allow the operation.Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.Unauthorized
- if you do not have all of the privileges described as follows: VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. void delete(java.lang.String vm, Credentials credentials, java.lang.String path, AsyncCallback<java.lang.Void> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
InvalidArgument
- if path
is not a file. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotAllowedInCurrentState
- if the virtual machine is not running.
NotFound
- if the virtual machine is not found.
NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
ResourceBusy
- if the virtual machine is busy.
ServiceUnavailable
- if the VMware Tools is not running.
Unauthenticated
- if the credentials
object was not valid.
Unauthorized
- if path
cannot be accessed.
Unauthorized
- if path
cannot be deleted because the guest authentication will not
allow the operation.
Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.
Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the file or symbolic link to be deleted.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void delete(java.lang.String vm, Credentials credentials, java.lang.String path, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Operation Errors:
InvalidArgument
- if path
is not a file. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotAllowedInCurrentState
- if the virtual machine is not running.
NotFound
- if the virtual machine is not found.
NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
ResourceBusy
- if the virtual machine is busy.
ServiceUnavailable
- if the VMware Tools is not running.
Unauthenticated
- if the credentials
object was not valid.
Unauthorized
- if path
cannot be accessed.
Unauthorized
- if path
cannot be deleted because the guest authentication will not
allow the operation.
Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.
Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the file or symbolic link to be deleted.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.FilesTypes.Info get(java.lang.String vm, Credentials credentials, java.lang.String path)
Synchronous method overload. Result of the invocation will be reported as a method return value.
vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the file.FilesTypes.Info
object containing
information for the file.InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotAllowedInCurrentState
- if the virtual machine is not running.NotFound
- if the virtual machine is not found.NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.ResourceBusy
- if the virtual machine is busy.ServiceUnavailable
- if the VMware Tools is not running.Unauthenticated
- if the credentials
object was not valid.Unauthorized
- if path
cannot be accessed.Unauthorized
- if path
cannot be listed because the guest authentication will not allow
the operation.Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.Unauthorized
- if you do not have all of the privileges described as follows: VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Query
. FilesTypes.Info get(java.lang.String vm, Credentials credentials, java.lang.String path, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the file.invocationConfig
- Configuration for the method invocation.FilesTypes.Info
object containing
information for the file.InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotAllowedInCurrentState
- if the virtual machine is not running.NotFound
- if the virtual machine is not found.NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.ResourceBusy
- if the virtual machine is busy.ServiceUnavailable
- if the VMware Tools is not running.Unauthenticated
- if the credentials
object was not valid.Unauthorized
- if path
cannot be accessed.Unauthorized
- if path
cannot be listed because the guest authentication will not allow
the operation.Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.Unauthorized
- if you do not have all of the privileges described as follows: VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Query
. void get(java.lang.String vm, Credentials credentials, java.lang.String path, AsyncCallback<FilesTypes.Info> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
FilesTypes.Info
object containing
information for the file.
Operation Errors:
InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotAllowedInCurrentState
- if the virtual machine is not running.
NotFound
- if the virtual machine is not found.
NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
ResourceBusy
- if the virtual machine is busy.
ServiceUnavailable
- if the VMware Tools is not running.
Unauthenticated
- if the credentials
object was not valid.
Unauthorized
- if path
cannot be accessed.
Unauthorized
- if path
cannot be listed because the guest authentication will not allow
the operation.
Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.
Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Query
. vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the file.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void get(java.lang.String vm, Credentials credentials, java.lang.String path, AsyncCallback<FilesTypes.Info> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
FilesTypes.Info
object containing
information for the file.
Operation Errors:
InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotAllowedInCurrentState
- if the virtual machine is not running.
NotFound
- if the virtual machine is not found.
NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
ResourceBusy
- if the virtual machine is busy.
ServiceUnavailable
- if the VMware Tools is not running.
Unauthenticated
- if the credentials
object was not valid.
Unauthorized
- if path
cannot be accessed.
Unauthorized
- if path
cannot be listed because the guest authentication will not allow
the operation.
Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.
Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Query
. vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the file.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String createTemporary(java.lang.String vm, Credentials credentials, java.lang.String prefix, java.lang.String suffix, java.lang.String parentPath)
Creates a new unique temporary file for the user to use as needed. The user is responsible for removing it when it is no longer needed.
The new file name will be created in a guest-specific format
using prefix
, a guest generated string and suffix
in parentPath
.
Synchronous method overload. Result of the invocation will be reported as a method return value.
vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.prefix
- The prefix to be given to the new temporary file.suffix
- The suffix to be given to the new temporary file.parentPath
- The complete path to the directory in which to create the file.
Directory to use if specified, otherwise a guest-specific default will be used.InvalidArgument
- if parentPath
is Set
and is not a directory. The value
of Error.getData()
will contain all the
properties defined in the FileErrorDetails
providing additional
information about the failure.InvalidArgument
- if parentPath
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotAllowedInCurrentState
- if the virtual machine is not running.NotFound
- if parentPath
is Set
and does not exist. The value of
Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotFound
- if the virtual machine is not found.ResourceBusy
- if the virtual machine is busy.ServiceUnavailable
- if the VMware Tools is not running.Unauthenticated
- if the credentials
object was not valid.Unauthorized
- if parentPath
cannot be accessed.Unauthorized
- if a file cannot be created because the guest authentication will not allow the
operation.Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.Unauthorized
- if you do not have all of the privileges described as follows: VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. java.lang.String createTemporary(java.lang.String vm, Credentials credentials, java.lang.String prefix, java.lang.String suffix, java.lang.String parentPath, InvocationConfig invocationConfig)
Creates a new unique temporary file for the user to use as needed. The user is responsible for removing it when it is no longer needed.
The new file name will be created in a guest-specific format
using prefix
, a guest generated string and suffix
in parentPath
.
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.prefix
- The prefix to be given to the new temporary file.suffix
- The suffix to be given to the new temporary file.parentPath
- The complete path to the directory in which to create the file.
Directory to use if specified, otherwise a guest-specific default will be used.invocationConfig
- Configuration for the method invocation.InvalidArgument
- if parentPath
is Set
and is not a directory. The value
of Error.getData()
will contain all the
properties defined in the FileErrorDetails
providing additional
information about the failure.InvalidArgument
- if parentPath
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotAllowedInCurrentState
- if the virtual machine is not running.NotFound
- if parentPath
is Set
and does not exist. The value of
Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.NotFound
- if the virtual machine is not found.ResourceBusy
- if the virtual machine is busy.ServiceUnavailable
- if the VMware Tools is not running.Unauthenticated
- if the credentials
object was not valid.Unauthorized
- if parentPath
cannot be accessed.Unauthorized
- if a file cannot be created because the guest authentication will not allow the
operation.Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.Unauthorized
- if you do not have all of the privileges described as follows: VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. void createTemporary(java.lang.String vm, Credentials credentials, java.lang.String prefix, java.lang.String suffix, java.lang.String parentPath, AsyncCallback<java.lang.String> asyncCallback)
Creates a new unique temporary file for the user to use as needed. The user is responsible for removing it when it is no longer needed.
The new file name will be created in a guest-specific format
using prefix
, a guest generated string and suffix
in parentPath
.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
The absolute path of the temporary file that is created.
Operation Errors:
InvalidArgument
- if parentPath
is Set
and is not a directory. The value
of Error.getData()
will contain all the
properties defined in the FileErrorDetails
providing additional
information about the failure.
InvalidArgument
- if parentPath
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotAllowedInCurrentState
- if the virtual machine is not running.
NotFound
- if parentPath
is Set
and does not exist. The value of
Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotFound
- if the virtual machine is not found.
ResourceBusy
- if the virtual machine is busy.
ServiceUnavailable
- if the VMware Tools is not running.
Unauthenticated
- if the credentials
object was not valid.
Unauthorized
- if parentPath
cannot be accessed.
Unauthorized
- if a file cannot be created because the guest authentication will not allow the
operation.
Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.
Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.prefix
- The prefix to be given to the new temporary file.suffix
- The suffix to be given to the new temporary file.parentPath
- The complete path to the directory in which to create the file.
Directory to use if specified, otherwise a guest-specific default will be used.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void createTemporary(java.lang.String vm, Credentials credentials, java.lang.String prefix, java.lang.String suffix, java.lang.String parentPath, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Creates a new unique temporary file for the user to use as needed. The user is responsible for removing it when it is no longer needed.
The new file name will be created in a guest-specific format
using prefix
, a guest generated string and suffix
in parentPath
.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
The absolute path of the temporary file that is created.
Operation Errors:
InvalidArgument
- if parentPath
is Set
and is not a directory. The value
of Error.getData()
will contain all the
properties defined in the FileErrorDetails
providing additional
information about the failure.
InvalidArgument
- if parentPath
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotAllowedInCurrentState
- if the virtual machine is not running.
NotFound
- if parentPath
is Set
and does not exist. The value of
Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
NotFound
- if the virtual machine is not found.
ResourceBusy
- if the virtual machine is busy.
ServiceUnavailable
- if the VMware Tools is not running.
Unauthenticated
- if the credentials
object was not valid.
Unauthorized
- if parentPath
cannot be accessed.
Unauthorized
- if a file cannot be created because the guest authentication will not allow the
operation.
Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.
Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Modify
. vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.prefix
- The prefix to be given to the new temporary file.suffix
- The suffix to be given to the new temporary file.parentPath
- The complete path to the directory in which to create the file.
Directory to use if specified, otherwise a guest-specific default will be used.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.FilesTypes.ListResult list(java.lang.String vm, Credentials credentials, java.lang.String path, FilesTypes.IterationSpec iteration, FilesTypes.FilterSpec filter)
Files are returned in operating system-specific (inode) order. If the directory is modified between queries, missing or duplicate results can occur.
. This method was added in vSphere API 7.0.2.0.Synchronous method overload. Result of the invocation will be reported as a method return value.
vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the directory or file to query.iteration
- The specification of a page of results to be retrieved.
If null
, the first page will be retrieved.filter
- Specification to match files for which information should be returned.
If null
, the behavior is the equivalent to a FilesTypes.FilterSpec
with all
properties null
which means all filenames match the filter.FilesTypes.ListResult
object
containing information for all the matching files in filter
and the
total number of files that can be returned.InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.InvalidArgument
- If contains invalid data.InvalidArgument
- If filter
contains an invalid regular expression.NotAllowedInCurrentState
- if the virtual machine is not running.NotFound
- if the virtual machine is not found.NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.ResourceBusy
- if the virtual machine is busy.ServiceUnavailable
- if the VMware Tools is not running.Unauthorized
- if path
cannot be accessed.Unauthorized
- if path
cannot be listed because the guest authentication will not allow
the operation.Unauthenticated
- if the credentials
object was not valid.Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.Unauthorized
- if you do not have all of the privileges described as follows: VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Query
. FilesTypes.ListResult list(java.lang.String vm, Credentials credentials, java.lang.String path, FilesTypes.IterationSpec iteration, FilesTypes.FilterSpec filter, InvocationConfig invocationConfig)
Files are returned in operating system-specific (inode) order. If the directory is modified between queries, missing or duplicate results can occur.
. This method was added in vSphere API 7.0.2.0.Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the directory or file to query.iteration
- The specification of a page of results to be retrieved.
If null
, the first page will be retrieved.filter
- Specification to match files for which information should be returned.
If null
, the behavior is the equivalent to a FilesTypes.FilterSpec
with all
properties null
which means all filenames match the filter.invocationConfig
- Configuration for the method invocation.FilesTypes.ListResult
object
containing information for all the matching files in filter
and the
total number of files that can be returned.InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.InvalidArgument
- If contains invalid data.InvalidArgument
- If filter
contains an invalid regular expression.NotAllowedInCurrentState
- if the virtual machine is not running.NotFound
- if the virtual machine is not found.NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.ResourceBusy
- if the virtual machine is busy.ServiceUnavailable
- if the VMware Tools is not running.Unauthorized
- if path
cannot be accessed.Unauthorized
- if path
cannot be listed because the guest authentication will not allow
the operation.Unauthenticated
- if the credentials
object was not valid.Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.Unauthorized
- if you do not have all of the privileges described as follows: VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Query
. void list(java.lang.String vm, Credentials credentials, java.lang.String path, FilesTypes.IterationSpec iteration, FilesTypes.FilterSpec filter, AsyncCallback<FilesTypes.ListResult> asyncCallback)
Files are returned in operating system-specific (inode) order. If the directory is modified between queries, missing or duplicate results can occur.
. This method was added in vSphere API 7.0.2.0.Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
A FilesTypes.ListResult
object
containing information for all the matching files in filter
and the
total number of files that can be returned.
Operation Errors:
InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
InvalidArgument
- If contains invalid data.
InvalidArgument
- If filter
contains an invalid regular expression.
NotAllowedInCurrentState
- if the virtual machine is not running.
NotFound
- if the virtual machine is not found.
NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
ResourceBusy
- if the virtual machine is busy.
ServiceUnavailable
- if the VMware Tools is not running.
Unauthorized
- if path
cannot be accessed.
Unauthorized
- if path
cannot be listed because the guest authentication will not allow
the operation.
Unauthenticated
- if the credentials
object was not valid.
Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.
Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Query
. vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the directory or file to query.iteration
- The specification of a page of results to be retrieved.
If null
, the first page will be retrieved.filter
- Specification to match files for which information should be returned.
If null
, the behavior is the equivalent to a FilesTypes.FilterSpec
with all
properties null
which means all filenames match the filter.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void list(java.lang.String vm, Credentials credentials, java.lang.String path, FilesTypes.IterationSpec iteration, FilesTypes.FilterSpec filter, AsyncCallback<FilesTypes.ListResult> asyncCallback, InvocationConfig invocationConfig)
Files are returned in operating system-specific (inode) order. If the directory is modified between queries, missing or duplicate results can occur.
. This method was added in vSphere API 7.0.2.0.Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
A FilesTypes.ListResult
object
containing information for all the matching files in filter
and the
total number of files that can be returned.
Operation Errors:
InvalidArgument
- if path
is too long. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
InvalidArgument
- If contains invalid data.
InvalidArgument
- If filter
contains an invalid regular expression.
NotAllowedInCurrentState
- if the virtual machine is not running.
NotFound
- if the virtual machine is not found.
NotFound
- if path
is not found. The value of Error.getData()
will contain all the properties
defined in the FileErrorDetails
providing additional information about the failure.
ResourceBusy
- if the virtual machine is busy.
ServiceUnavailable
- if the VMware Tools is not running.
Unauthorized
- if path
cannot be accessed.
Unauthorized
- if path
cannot be listed because the guest authentication will not allow
the operation.
Unauthenticated
- if the credentials
object was not valid.
Unsupported
- if the operation is not supported by the VMware Tools in the guest operating
system.
Unsupported
- if the operation is disabled by the VMware Tools in the guest operating system.
Unauthorized
- if you do not have all of the privileges described as follows:
VirtualMachine
referenced by the parameter vm
requires
VirtualMachine.GuestOperations.Query
. vm
- Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine
.credentials
- The guest authentication data.path
- The complete path to the directory or file to query.iteration
- The specification of a page of results to be retrieved.
If null
, the first page will be retrieved.filter
- Specification to match files for which information should be returned.
If null
, the behavior is the equivalent to a FilesTypes.FilterSpec
with all
properties null
which means all filenames match the filter.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.