com.vmware.vcenter.vm.guest.filesystem

Interface Directories

All Superinterfaces:

DirectoriesTypes, Service

All Known Implementing Classes:

DirectoriesStub

public interface Directories
extends Service, DirectoriesTypes

The Directories interface provides methods to manage directories in the guest filesystem. This interface was added in vSphere API 7.0.2.0.

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.guest.filesystem.DirectoriesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.Boolean createParents) Creates a directory in the guest operating system.
void	create(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.Boolean createParents, AsyncCallback<java.lang.Void> asyncCallback) Creates a directory in the guest operating system.
void	create(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.Boolean createParents, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Creates a directory in the guest operating system.
void	create(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.Boolean createParents, InvocationConfig invocationConfig) Creates a directory in the guest operating system.
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 directory.
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 directory.
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 directory.
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 directory.
void	delete(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.Boolean recursive) Deletes a directory in the guest operating system.
void	delete(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.Boolean recursive, AsyncCallback<java.lang.Void> asyncCallback) Deletes a directory in the guest operating system.
void	delete(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.Boolean recursive, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes a directory in the guest operating system.
void	delete(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.Boolean recursive, InvocationConfig invocationConfig) Deletes a directory in the guest operating system.
void	move(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.String newPath) Renames a directory in the guest.
void	move(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.String newPath, AsyncCallback<java.lang.Void> asyncCallback) Renames a directory in the guest.
void	move(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.String newPath, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Renames a directory in the guest.
void	move(java.lang.String vm, Credentials credentials, java.lang.String path, java.lang.String newPath, InvocationConfig invocationConfig) Renames a directory in the guest.

Method Detail

create

void create(java.lang.String vm,
            Credentials credentials,
            java.lang.String path,
            java.lang.Boolean createParents)

Creates a directory in the guest operating system.

. 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.

Parameters:

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 to be created.

createParents - Whether any parent directories should be created. If any failure occurs, some parent directories could be left behind. If null parent directories are not created.

Throws:

AlreadyExists - if path already exists.

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 does not exist and createParents is not set. 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 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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

create

void create(java.lang.String vm,
            Credentials credentials,
            java.lang.String path,
            java.lang.Boolean createParents,
            InvocationConfig invocationConfig)

Creates a directory in the guest operating system.

. 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.

Parameters:

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 to be created.

createParents - Whether any parent directories should be created. If any failure occurs, some parent directories could be left behind. If null parent directories are not created.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyExists - if path already exists.

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 does not exist and createParents is not set. 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 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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

create

void create(java.lang.String vm,
            Credentials credentials,
            java.lang.String path,
            java.lang.Boolean createParents,
            AsyncCallback<java.lang.Void> asyncCallback)

Creates a directory in the guest operating system.

. 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.

Operation Errors:
AlreadyExists - if path already exists.
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 does not exist and createParents is not set. 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 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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

Parameters:

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 to be created.

createParents - Whether any parent directories should be created. If any failure occurs, some parent directories could be left behind. If null parent directories are not created.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create

void create(java.lang.String vm,
            Credentials credentials,
            java.lang.String path,
            java.lang.Boolean createParents,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Creates a directory in the guest operating system.

. 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.

Operation Errors:
AlreadyExists - if path already exists.
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 does not exist and createParents is not set. 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 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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

Parameters:

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 to be created.

createParents - Whether any parent directories should be created. If any failure occurs, some parent directories could be left behind. If null parent directories are not created.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String vm,
            Credentials credentials,
            java.lang.String path,
            java.lang.Boolean recursive)

Deletes a directory in the guest operating system.

. 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.

Parameters:

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 to be deleted.

recursive - If true, all files and subdirectories are also deleted. If false, the directory must be empty for the operation to succeed. If null, any directory content is not deleted.

Throws:

InvalidArgument - if path 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 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.

ResourceInUse - if path has content and recursive is null.

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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

delete

void delete(java.lang.String vm,
            Credentials credentials,
            java.lang.String path,
            java.lang.Boolean recursive,
            InvocationConfig invocationConfig)

Deletes a directory in the guest operating system.

. 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.

Parameters:

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 to be deleted.

recursive - If true, all files and subdirectories are also deleted. If false, the directory must be empty for the operation to succeed. If null, any directory content is not deleted.

invocationConfig - Configuration for the method invocation.

Throws:

InvalidArgument - if path 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 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.

ResourceInUse - if path has content and recursive is null.

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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

delete

void delete(java.lang.String vm,
            Credentials credentials,
            java.lang.String path,
            java.lang.Boolean recursive,
            AsyncCallback<java.lang.Void> asyncCallback)

Deletes a directory in the guest operating system.

. 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.

Operation Errors:
InvalidArgument - if path 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 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.
ResourceInUse - if path has content and recursive is null.
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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

Parameters:

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 to be deleted.

recursive - If true, all files and subdirectories are also deleted. If false, the directory must be empty for the operation to succeed. If null, any directory content is not deleted.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

void delete(java.lang.String vm,
            Credentials credentials,
            java.lang.String path,
            java.lang.Boolean recursive,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Deletes a directory in the guest operating system.

. 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.

Operation Errors:
InvalidArgument - if path 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 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.
ResourceInUse - if path has content and recursive is null.
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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

Parameters:

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 to be deleted.

recursive - If true, all files and subdirectories are also deleted. If false, the directory must be empty for the operation to succeed. If null, any directory content is not deleted.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

move

void move(java.lang.String vm,
          Credentials credentials,
          java.lang.String path,
          java.lang.String newPath)

Renames a directory in the guest.

Renames the directory, or copies and deletes the old contents as required by the underlying filsystem.

. 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.

Parameters:

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 to be moved.

newPath - The complete path to where the directory is moved or its new name. It cannot be a path to an existing directory or an existing file.

Throws:

AlreadyExists - if newPath already exists.

InvalidArgument - if path 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 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 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.

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 or moved 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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

move

void move(java.lang.String vm,
          Credentials credentials,
          java.lang.String path,
          java.lang.String newPath,
          InvocationConfig invocationConfig)

Renames a directory in the guest.

Renames the directory, or copies and deletes the old contents as required by the underlying filsystem.

. 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.

Parameters:

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 to be moved.

newPath - The complete path to where the directory is moved or its new name. It cannot be a path to an existing directory or an existing file.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyExists - if newPath already exists.

InvalidArgument - if path 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 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 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.

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 or moved 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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

move

void move(java.lang.String vm,
          Credentials credentials,
          java.lang.String path,
          java.lang.String newPath,
          AsyncCallback<java.lang.Void> asyncCallback)

Renames a directory in the guest.

Renames the directory, or copies and deletes the old contents as required by the underlying filsystem.

. 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.

Operation Errors:
AlreadyExists - if newPath already exists.
InvalidArgument - if path 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 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 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.
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 or moved 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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

Parameters:

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 to be moved.

newPath - The complete path to where the directory is moved or its new name. It cannot be a path to an existing directory or an existing file.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

move

void move(java.lang.String vm,
          Credentials credentials,
          java.lang.String path,
          java.lang.String newPath,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Renames a directory in the guest.

Renames the directory, or copies and deletes the old contents as required by the underlying filsystem.

. 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.

Operation Errors:
AlreadyExists - if newPath already exists.
InvalidArgument - if path 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 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 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.
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 or moved 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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

Parameters:

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 to be moved.

newPath - The complete path to where the directory is moved or its new name. It cannot be a path to an existing directory or an existing file.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

createTemporary

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 directory.

Creates a new unique temporary directory for the user to use as needed. The guest operating system may clean up the directory after a guest specific amount of time if parentPath is not set, or the user can remove the directory when no longer needed.

The new directory name will be created in a guest-specific format using prefix, a guest generated string and suffix in parentPath.

. 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.

Parameters:

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 directory.

suffix - The suffix to be given to the new temporary directory.

parentPath - The complete path to the directory in which to create the new directory. Directory If null a guest-specific default will be used.

Returns:

The absolute path of the temporary directory that is created.

Throws:

InvalidArgument - if parentPath 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 the virtual machine is not found.

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.

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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

createTemporary

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 directory.

Creates a new unique temporary directory for the user to use as needed. The guest operating system may clean up the directory after a guest specific amount of time if parentPath is not set, or the user can remove the directory when no longer needed.

The new directory name will be created in a guest-specific format using prefix, a guest generated string and suffix in parentPath.

. 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.

Parameters:

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 directory.

suffix - The suffix to be given to the new temporary directory.

parentPath - The complete path to the directory in which to create the new directory. Directory If null a guest-specific default will be used.

invocationConfig - Configuration for the method invocation.

Returns:

The absolute path of the temporary directory that is created.

Throws:

InvalidArgument - if parentPath 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 the virtual machine is not found.

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.

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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

createTemporary

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 directory.

Creates a new unique temporary directory for the user to use as needed. The guest operating system may clean up the directory after a guest specific amount of time if parentPath is not set, or the user can remove the directory when no longer needed.

The new directory name will be created in a guest-specific format using prefix, a guest generated string and suffix in parentPath.

. 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:
The absolute path of the temporary directory that is created.

Operation Errors:
InvalidArgument - if parentPath 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 the virtual machine is not found.
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.
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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

Parameters:

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 directory.

suffix - The suffix to be given to the new temporary directory.

parentPath - The complete path to the directory in which to create the new directory. Directory If null a guest-specific default will be used.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

createTemporary

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 directory.

Creates a new unique temporary directory for the user to use as needed. The guest operating system may clean up the directory after a guest specific amount of time if parentPath is not set, or the user can remove the directory when no longer needed.

The new directory name will be created in a guest-specific format using prefix, a guest generated string and suffix in parentPath.

. 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:
The absolute path of the temporary directory that is created.

Operation Errors:
InvalidArgument - if parentPath 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 the virtual machine is not found.
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.
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:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.

Parameters:

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 directory.

suffix - The suffix to be given to the new temporary directory.

parentPath - The complete path to the directory in which to create the new directory. Directory If null 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.