The VM interface provides methods for managing the lifecycle of a virtual machine. More...

Inherited by vmware::vcenter::VMStub.

Public Member Functions
string	Create (vmware.vcenter.VMTypes.CreateSpec spec)
	Creates a virtual machine.
string	Create (vmware.vcenter.VMTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a virtual machine.
global::System.Threading.Tasks.Task < string >	CreateAsync (vmware.vcenter.VMTypes.CreateSpec spec)
	Creates a virtual machine.
global::System.Threading.Tasks.Task < string >	CreateAsync (vmware.vcenter.VMTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a virtual machine.
string	Clone (vmware.vcenter.VMTypes.CloneSpec spec)
	Creates a virtual machine from an existing virtual machine.
string	Clone (vmware.vcenter.VMTypes.CloneSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a virtual machine from an existing virtual machine.
string	Clone_Task (vmware.vcenter.VMTypes.CloneSpec spec)
	Creates a virtual machine from an existing virtual machine.
string	Clone_Task (vmware.vcenter.VMTypes.CloneSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a virtual machine from an existing virtual machine.
global::System.Threading.Tasks.Task < string >	CloneAsync (vmware.vcenter.VMTypes.CloneSpec spec)
	Creates a virtual machine from an existing virtual machine.
global::System.Threading.Tasks.Task < string >	CloneAsync (vmware.vcenter.VMTypes.CloneSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a virtual machine from an existing virtual machine.
void	Relocate (string vm, vmware.vcenter.VMTypes.RelocateSpec spec)
	Relocates a virtual machine based on the specification.
void	Relocate (string vm, vmware.vcenter.VMTypes.RelocateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Relocates a virtual machine based on the specification.
string	Relocate_Task (string vm, vmware.vcenter.VMTypes.RelocateSpec spec)
	Relocates a virtual machine based on the specification.
string	Relocate_Task (string vm, vmware.vcenter.VMTypes.RelocateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Relocates a virtual machine based on the specification.
global::System.Threading.Tasks.Task	RelocateAsync (string vm, vmware.vcenter.VMTypes.RelocateSpec spec)
	Relocates a virtual machine based on the specification.
global::System.Threading.Tasks.Task	RelocateAsync (string vm, vmware.vcenter.VMTypes.RelocateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Relocates a virtual machine based on the specification.
string	InstantClone (vmware.vcenter.VMTypes.InstantCloneSpec spec)
	Create an instant clone of an existing virtual machine.
string	InstantClone (vmware.vcenter.VMTypes.InstantCloneSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Create an instant clone of an existing virtual machine.
global::System.Threading.Tasks.Task < string >	InstantCloneAsync (vmware.vcenter.VMTypes.InstantCloneSpec spec)
	Create an instant clone of an existing virtual machine.
global::System.Threading.Tasks.Task < string >	InstantCloneAsync (vmware.vcenter.VMTypes.InstantCloneSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Create an instant clone of an existing virtual machine.
vmware.vcenter.VMTypes.Info	Get (string vm)
	Returns information about a virtual machine.
vmware.vcenter.VMTypes.Info	Get (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about a virtual machine.
global::System.Threading.Tasks.Task < vmware.vcenter.VMTypes.Info >	GetAsync (string vm)
	Returns information about a virtual machine.
global::System.Threading.Tasks.Task < vmware.vcenter.VMTypes.Info >	GetAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about a virtual machine.
void	Delete (string vm)
	Deletes a virtual machine.
void	Delete (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Deletes a virtual machine.
global::System.Threading.Tasks.Task	DeleteAsync (string vm)
	Deletes a virtual machine.
global::System.Threading.Tasks.Task	DeleteAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Deletes a virtual machine.
global::System.Collections.Generic.List < vmware.vcenter.VMTypes.Summary >	List (vmware.vcenter.VMTypes.FilterSpec filter)
	Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec .
global::System.Collections.Generic.List < vmware.vcenter.VMTypes.Summary >	List (vmware.vcenter.VMTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec .
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vcenter.VMTypes.Summary > >	ListAsync (vmware.vcenter.VMTypes.FilterSpec filter)
	Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec .
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vcenter.VMTypes.Summary > >	ListAsync (vmware.vcenter.VMTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec .
string	Register (vmware.vcenter.VMTypes.RegisterSpec spec)
	Creates a virtual machine from existing virtual machine files on storage.
string	Register (vmware.vcenter.VMTypes.RegisterSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a virtual machine from existing virtual machine files on storage.
global::System.Threading.Tasks.Task < string >	RegisterAsync (vmware.vcenter.VMTypes.RegisterSpec spec)
	Creates a virtual machine from existing virtual machine files on storage.
global::System.Threading.Tasks.Task < string >	RegisterAsync (vmware.vcenter.VMTypes.RegisterSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a virtual machine from existing virtual machine files on storage.
void	Unregister (string vm)
	Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage.
void	Unregister (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage.
global::System.Threading.Tasks.Task	UnregisterAsync (string vm)
	Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage.
global::System.Threading.Tasks.Task	UnregisterAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage.

Detailed Description

The VM interface provides methods for managing the lifecycle of a virtual machine.

Member Function Documentation

string vmware::vcenter::VM::Clone ( vmware.vcenter.VMTypes.CloneSpec spec )

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to clone the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Datastore` referenced by the attribute VM.DiskCloneSpec.datastore requires `Datastore.AllocateSpace` . The resource `Datastore` referenced by the attribute VM.ClonePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Folder` referenced by the attribute VM.ClonePlacementSpec.folder requires `VirtualMachine.Inventory.CreateFromExisting` . The resource `ResourcePool` referenced by the attribute VM.ClonePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `VirtualMachine` referenced by the attribute VM.CloneSpec.source requires `VirtualMachine.Provisioning.Clone` .

Parameters:

spec	Virtual machine clone specification.

Returns:: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

string vmware::vcenter::VM::Clone	(	vmware.vcenter.VMTypes.CloneSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to clone the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Datastore` referenced by the attribute VM.DiskCloneSpec.datastore requires `Datastore.AllocateSpace` . The resource `Datastore` referenced by the attribute VM.ClonePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Folder` referenced by the attribute VM.ClonePlacementSpec.folder requires `VirtualMachine.Inventory.CreateFromExisting` . The resource `ResourcePool` referenced by the attribute VM.ClonePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `VirtualMachine` referenced by the attribute VM.CloneSpec.source requires `VirtualMachine.Provisioning.Clone` .

Parameters:

spec	Virtual machine clone specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

string vmware::vcenter::VM::Clone_Task	(	vmware.vcenter.VMTypes.CloneSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to clone the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Datastore` referenced by the attribute VM.DiskCloneSpec.datastore requires `Datastore.AllocateSpace` . The resource `Datastore` referenced by the attribute VM.ClonePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Folder` referenced by the attribute VM.ClonePlacementSpec.folder requires `VirtualMachine.Inventory.CreateFromExisting` . The resource `ResourcePool` referenced by the attribute VM.ClonePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `VirtualMachine` referenced by the attribute VM.CloneSpec.source requires `VirtualMachine.Provisioning.Clone` .

Parameters:

spec	Virtual machine clone specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: Identifier for the task created by this API invocation

Implemented in vmware::vcenter::VMStub.

string vmware::vcenter::VM::Clone_Task ( vmware.vcenter.VMTypes.CloneSpec spec )

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to clone the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Datastore` referenced by the attribute VM.DiskCloneSpec.datastore requires `Datastore.AllocateSpace` . The resource `Datastore` referenced by the attribute VM.ClonePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Folder` referenced by the attribute VM.ClonePlacementSpec.folder requires `VirtualMachine.Inventory.CreateFromExisting` . The resource `ResourcePool` referenced by the attribute VM.ClonePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `VirtualMachine` referenced by the attribute VM.CloneSpec.source requires `VirtualMachine.Provisioning.Clone` .

Parameters:

spec	Virtual machine clone specification.

Returns:: Identifier for the task created by this API invocation

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::VM::CloneAsync ( vmware.vcenter.VMTypes.CloneSpec spec )

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to clone the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Datastore` referenced by the attribute VM.DiskCloneSpec.datastore requires `Datastore.AllocateSpace` . The resource `Datastore` referenced by the attribute VM.ClonePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Folder` referenced by the attribute VM.ClonePlacementSpec.folder requires `VirtualMachine.Inventory.CreateFromExisting` . The resource `ResourcePool` referenced by the attribute VM.ClonePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `VirtualMachine` referenced by the attribute VM.CloneSpec.source requires `VirtualMachine.Provisioning.Clone` .

Parameters:

spec	Virtual machine clone specification.

Returns:: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::VM::CloneAsync	(	vmware.vcenter.VMTypes.CloneSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Creates a virtual machine from an existing virtual machine.

. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to clone the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Datastore` referenced by the attribute VM.DiskCloneSpec.datastore requires `Datastore.AllocateSpace` . The resource `Datastore` referenced by the attribute VM.ClonePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Folder` referenced by the attribute VM.ClonePlacementSpec.folder requires `VirtualMachine.Inventory.CreateFromExisting` . The resource `ResourcePool` referenced by the attribute VM.ClonePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `VirtualMachine` referenced by the attribute VM.CloneSpec.source requires `VirtualMachine.Provisioning.Clone` .

Parameters:

spec	Virtual machine clone specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

string vmware::vcenter::VM::Create ( vmware.vcenter.VMTypes.CreateSpec spec )

Creates a virtual machine.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ResourceInUse	if any of the specified storage addresses (eg. IDE, SATA, SCSI, NVMe) result in a storage address conflict.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to create the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unsupported	if `guestOS` is not supported for the requested virtual hardware version and spec includes null fields that default to guest-specific values.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Folder` referenced by the attribute VM.InventoryPlacementSpec.folder requires `VirtualMachine.Inventory.Create` . The resource `ResourcePool` referenced by the attribute VM.ComputePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `Datastore` referenced by the attribute VM.StoragePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Network` referenced by the attribute vm.hardware.Ethernet.BackingSpec.network requires `Network.Assign` .

Parameters:

spec	Virtual machine specification.

Returns:: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

string vmware::vcenter::VM::Create	(	vmware.vcenter.VMTypes.CreateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Creates a virtual machine.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ResourceInUse	if any of the specified storage addresses (eg. IDE, SATA, SCSI, NVMe) result in a storage address conflict.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to create the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unsupported	if `guestOS` is not supported for the requested virtual hardware version and spec includes null fields that default to guest-specific values.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Folder` referenced by the attribute VM.InventoryPlacementSpec.folder requires `VirtualMachine.Inventory.Create` . The resource `ResourcePool` referenced by the attribute VM.ComputePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `Datastore` referenced by the attribute VM.StoragePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Network` referenced by the attribute vm.hardware.Ethernet.BackingSpec.network requires `Network.Assign` .

Parameters:

spec	Virtual machine specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::VM::CreateAsync	(	vmware.vcenter.VMTypes.CreateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Creates a virtual machine.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ResourceInUse	if any of the specified storage addresses (eg. IDE, SATA, SCSI, NVMe) result in a storage address conflict.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to create the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unsupported	if `guestOS` is not supported for the requested virtual hardware version and spec includes null fields that default to guest-specific values.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Folder` referenced by the attribute VM.InventoryPlacementSpec.folder requires `VirtualMachine.Inventory.Create` . The resource `ResourcePool` referenced by the attribute VM.ComputePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `Datastore` referenced by the attribute VM.StoragePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Network` referenced by the attribute vm.hardware.Ethernet.BackingSpec.network requires `Network.Assign` .

Parameters:

spec	Virtual machine specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::VM::CreateAsync ( vmware.vcenter.VMTypes.CreateSpec spec )

Creates a virtual machine.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ResourceInUse	if any of the specified storage addresses (eg. IDE, SATA, SCSI, NVMe) result in a storage address conflict.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to create the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unsupported	if `guestOS` is not supported for the requested virtual hardware version and spec includes null fields that default to guest-specific values.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Folder` referenced by the attribute VM.InventoryPlacementSpec.folder requires `VirtualMachine.Inventory.Create` . The resource `ResourcePool` referenced by the attribute VM.ComputePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `Datastore` referenced by the attribute VM.StoragePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Network` referenced by the attribute vm.hardware.Ethernet.BackingSpec.network requires `Network.Assign` .

Parameters:

spec	Virtual machine specification.

Returns:: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

void vmware::vcenter::VM::Delete ( string vm )

Deletes a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is running (powered on).
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `VirtualMachine.Inventory.Delete` .

Parameters:

vm	Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine` .

Implemented in vmware::vcenter::VMStub.

void vmware::vcenter::VM::Delete	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Deletes a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is running (powered on).
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `VirtualMachine.Inventory.Delete` .

Parameters:

vm	Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine` .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task vmware::vcenter::VM::DeleteAsync ( string vm )

Deletes a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is running (powered on).
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `VirtualMachine.Inventory.Delete` .

Parameters:

vm	Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine` .

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task vmware::vcenter::VM::DeleteAsync	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Deletes a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is running (powered on).
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `VirtualMachine.Inventory.Delete` .

Parameters:

vm	Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine` .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::VMStub.

vmware.vcenter.VMTypes.Info vmware::vcenter::VM::Get ( string vm )

Returns information about a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `System.Read` .

Parameters:

vm	Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine` .

Returns:: Information about the specified virtual machine.

Implemented in vmware::vcenter::VMStub.

vmware.vcenter.VMTypes.Info vmware::vcenter::VM::Get	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns information about a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `System.Read` .

Parameters:

vm	Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine` .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: Information about the specified virtual machine.

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task<vmware.vcenter.VMTypes.Info> vmware::vcenter::VM::GetAsync ( string vm )

Returns information about a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `System.Read` .

Parameters:

vm	Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine` .

Returns:: Information about the specified virtual machine.

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task<vmware.vcenter.VMTypes.Info> vmware::vcenter::VM::GetAsync	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns information about a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `System.Read` .

Parameters:

vm	Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine` .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: Information about the specified virtual machine.

Implemented in vmware::vcenter::VMStub.

string vmware::vcenter::VM::InstantClone ( vmware.vcenter.VMTypes.InstantCloneSpec spec )

Create an instant clone of an existing virtual machine.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to create an instant clone could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the attribute VM.InstantCloneSpec.source requires `VirtualMachine.Provisioning.Clone` and `VirtualMachine.Inventory.CreateFromExisting` . The resource `Folder` referenced by the attribute VM.InstantClonePlacementSpec.folder requires `VirtualMachine.Interact.PowerOn` . The resource `ResourcePool` referenced by the attribute VM.InstantClonePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `Datastore` referenced by the attribute VM.InstantClonePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Network` referenced by the attribute vm.hardware.Ethernet.BackingSpec.network requires `Network.Assign` .

Parameters:

spec	Virtual machine InstantCloneSpec.

Returns:: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

string vmware::vcenter::VM::InstantClone	(	vmware.vcenter.VMTypes.InstantCloneSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Create an instant clone of an existing virtual machine.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to create an instant clone could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the attribute VM.InstantCloneSpec.source requires `VirtualMachine.Provisioning.Clone` and `VirtualMachine.Inventory.CreateFromExisting` . The resource `Folder` referenced by the attribute VM.InstantClonePlacementSpec.folder requires `VirtualMachine.Interact.PowerOn` . The resource `ResourcePool` referenced by the attribute VM.InstantClonePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `Datastore` referenced by the attribute VM.InstantClonePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Network` referenced by the attribute vm.hardware.Ethernet.BackingSpec.network requires `Network.Assign` .

Parameters:

spec	Virtual machine InstantCloneSpec.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::VM::InstantCloneAsync ( vmware.vcenter.VMTypes.InstantCloneSpec spec )

Create an instant clone of an existing virtual machine.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to create an instant clone could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the attribute VM.InstantCloneSpec.source requires `VirtualMachine.Provisioning.Clone` and `VirtualMachine.Inventory.CreateFromExisting` . The resource `Folder` referenced by the attribute VM.InstantClonePlacementSpec.folder requires `VirtualMachine.Interact.PowerOn` . The resource `ResourcePool` referenced by the attribute VM.InstantClonePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `Datastore` referenced by the attribute VM.InstantClonePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Network` referenced by the attribute vm.hardware.Ethernet.BackingSpec.network requires `Network.Assign` .

Parameters:

spec	Virtual machine InstantCloneSpec.

Returns:: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::VM::InstantCloneAsync	(	vmware.vcenter.VMTypes.InstantCloneSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Create an instant clone of an existing virtual machine.

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to create an instant clone could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the attribute VM.InstantCloneSpec.source requires `VirtualMachine.Provisioning.Clone` and `VirtualMachine.Inventory.CreateFromExisting` . The resource `Folder` referenced by the attribute VM.InstantClonePlacementSpec.folder requires `VirtualMachine.Interact.PowerOn` . The resource `ResourcePool` referenced by the attribute VM.InstantClonePlacementSpec.resourcePool requires `Resource.AssignVMToPool` . The resource `Datastore` referenced by the attribute VM.InstantClonePlacementSpec.datastore requires `Datastore.AllocateSpace` . The resource `Network` referenced by the attribute vm.hardware.Ethernet.BackingSpec.network requires `Network.Assign` .

Parameters:

spec	Virtual machine InstantCloneSpec.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

global::System.Collections.Generic.List<vmware.vcenter.VMTypes.Summary> vmware::vcenter::VM::List ( vmware.vcenter.VMTypes.FilterSpec filter )

Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec .

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the VM.FilterSpec.powerStates field contains a value that is not supported by the server.
vmware.vapi.std.errors.UnableToAllocateResource	if more than 4000 virtual machines match the VM.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

filter Specification of matching virtual machines for which information should be returned. If null, the behavior is equivalent to a VM.FilterSpec with all fields null which means all virtual machines match the filter.

Returns:: Commonly used information about the virtual machines matching the VM.FilterSpec .

Implemented in vmware::vcenter::VMStub.

global::System.Collections.Generic.List<vmware.vcenter.VMTypes.Summary> vmware::vcenter::VM::List	(	vmware.vcenter.VMTypes.FilterSpec	filter,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec .

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the VM.FilterSpec.powerStates field contains a value that is not supported by the server.
vmware.vapi.std.errors.UnableToAllocateResource	if more than 4000 virtual machines match the VM.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

filter	Specification of matching virtual machines for which information should be returned. If null, the behavior is equivalent to a VM.FilterSpec with all fields null which means all virtual machines match the filter.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: Commonly used information about the virtual machines matching the VM.FilterSpec .

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.VMTypes.Summary> > vmware::vcenter::VM::ListAsync	(	vmware.vcenter.VMTypes.FilterSpec	filter,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec .

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the VM.FilterSpec.powerStates field contains a value that is not supported by the server.
vmware.vapi.std.errors.UnableToAllocateResource	if more than 4000 virtual machines match the VM.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

filter	Specification of matching virtual machines for which information should be returned. If null, the behavior is equivalent to a VM.FilterSpec with all fields null which means all virtual machines match the filter.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: Commonly used information about the virtual machines matching the VM.FilterSpec .

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.VMTypes.Summary> > vmware::vcenter::VM::ListAsync ( vmware.vcenter.VMTypes.FilterSpec filter )

Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec .

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the VM.FilterSpec.powerStates field contains a value that is not supported by the server.
vmware.vapi.std.errors.UnableToAllocateResource	if more than 4000 virtual machines match the VM.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

filter Specification of matching virtual machines for which information should be returned. If null, the behavior is equivalent to a VM.FilterSpec with all fields null which means all virtual machines match the filter.

Returns:: Commonly used information about the virtual machines matching the VM.FilterSpec .

Implemented in vmware::vcenter::VMStub.

string vmware::vcenter::VM::Register ( vmware.vcenter.VMTypes.RegisterSpec spec )

Creates a virtual machine from existing virtual machine files on storage.

This method was added in vSphere API 6.8.7.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists or if a virtual machine using the specified virtual machine files already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found.
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to register the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user cannot be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Datastore` referenced by the attribute VM.RegisterSpec.datastore requires `System.Read` . The resource `Folder` referenced by the attribute VM.InventoryPlacementSpec.folder requires `VirtualMachine.Inventory.Register` . The resource `ResourcePool` referenced by the attribute VM.ComputePlacementSpec.resourcePool requires `Resource.AssignVMToPool` .

Parameters:

spec	Specification of the location of the virtual machine files and the placement of the new virtual machine.

Returns:: Identifier of the newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

string vmware::vcenter::VM::Register	(	vmware.vcenter.VMTypes.RegisterSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Creates a virtual machine from existing virtual machine files on storage.

This method was added in vSphere API 6.8.7.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists or if a virtual machine using the specified virtual machine files already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found.
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to register the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user cannot be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Datastore` referenced by the attribute VM.RegisterSpec.datastore requires `System.Read` . The resource `Folder` referenced by the attribute VM.InventoryPlacementSpec.folder requires `VirtualMachine.Inventory.Register` . The resource `ResourcePool` referenced by the attribute VM.ComputePlacementSpec.resourcePool requires `Resource.AssignVMToPool` .

Parameters:

spec	Specification of the location of the virtual machine files and the placement of the new virtual machine.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: Identifier of the newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::VM::RegisterAsync	(	vmware.vcenter.VMTypes.RegisterSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Creates a virtual machine from existing virtual machine files on storage.

This method was added in vSphere API 6.8.7.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists or if a virtual machine using the specified virtual machine files already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found.
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to register the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user cannot be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Datastore` referenced by the attribute VM.RegisterSpec.datastore requires `System.Read` . The resource `Folder` referenced by the attribute VM.InventoryPlacementSpec.folder requires `VirtualMachine.Inventory.Register` . The resource `ResourcePool` referenced by the attribute VM.ComputePlacementSpec.resourcePool requires `Resource.AssignVMToPool` .

Parameters:

spec	Specification of the location of the virtual machine files and the placement of the new virtual machine.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:: Identifier of the newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::VM::RegisterAsync ( vmware.vcenter.VMTypes.RegisterSpec spec )

Creates a virtual machine from existing virtual machine files on storage.

This method was added in vSphere API 6.8.7.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a virtual machine with the specified name already exists or if a virtual machine using the specified virtual machine files already exists.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec could not be found.
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.UnableToAllocateResource	if any of the resources needed to register the virtual machine could not be allocated.
vmware.vapi.std.errors.Unauthenticated	if the user cannot be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `Datastore` referenced by the attribute VM.RegisterSpec.datastore requires `System.Read` . The resource `Folder` referenced by the attribute VM.InventoryPlacementSpec.folder requires `VirtualMachine.Inventory.Register` . The resource `ResourcePool` referenced by the attribute VM.ComputePlacementSpec.resourcePool requires `Resource.AssignVMToPool` .

Parameters:

spec	Specification of the location of the virtual machine files and the placement of the new virtual machine.

Returns:: Identifier of the newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implemented in vmware::vcenter::VMStub.

void vmware::vcenter::VM::Relocate	(	string	vm,
		vmware.vcenter.VMTypes.RelocateSpec	spec
	)

Relocates a virtual machine based on the specification.

The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec or the given "vm" could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `Resource.ColdMigrate` . The resource `ResourcePool` referenced by the attribute VM.RelocatePlacementSpec.resourcePool requires `Resource.AssignVMToPool` .

Parameters:

vm	Existing Virtual machine to relocate. The parameter must be an identifier for the resource type: `VirtualMachine` .
spec	Relocate specification.

Implemented in vmware::vcenter::VMStub.

void vmware::vcenter::VM::Relocate	(	string	vm,
		vmware.vcenter.VMTypes.RelocateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Relocates a virtual machine based on the specification.

The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec or the given "vm" could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `Resource.ColdMigrate` . The resource `ResourcePool` referenced by the attribute VM.RelocatePlacementSpec.resourcePool requires `Resource.AssignVMToPool` .

Parameters:

vm	Existing Virtual machine to relocate. The parameter must be an identifier for the resource type: `VirtualMachine` .
spec	Relocate specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::VMStub.

string vmware::vcenter::VM::Relocate_Task	(	string	vm,
		vmware.vcenter.VMTypes.RelocateSpec	spec
	)

Relocates a virtual machine based on the specification.

The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec or the given "vm" could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `Resource.ColdMigrate` . The resource `ResourcePool` referenced by the attribute VM.RelocatePlacementSpec.resourcePool requires `Resource.AssignVMToPool` .

Parameters:

vm	Existing Virtual machine to relocate. The parameter must be an identifier for the resource type: `VirtualMachine` .
spec	Relocate specification.

Implemented in vmware::vcenter::VMStub.

string vmware::vcenter::VM::Relocate_Task	(	string	vm,
		vmware.vcenter.VMTypes.RelocateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Relocates a virtual machine based on the specification.

The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec or the given "vm" could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `Resource.ColdMigrate` . The resource `ResourcePool` referenced by the attribute VM.RelocatePlacementSpec.resourcePool requires `Resource.AssignVMToPool` .

Parameters:

vm	Existing Virtual machine to relocate. The parameter must be an identifier for the resource type: `VirtualMachine` .
spec	Relocate specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task vmware::vcenter::VM::RelocateAsync	(	string	vm,
		vmware.vcenter.VMTypes.RelocateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Relocates a virtual machine based on the specification.

The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec or the given "vm" could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `Resource.ColdMigrate` . The resource `ResourcePool` referenced by the attribute VM.RelocatePlacementSpec.resourcePool requires `Resource.AssignVMToPool` .

Parameters:

vm	Existing Virtual machine to relocate. The parameter must be an identifier for the resource type: `VirtualMachine` .
spec	Relocate specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task vmware::vcenter::VM::RelocateAsync	(	string	vm,
		vmware.vcenter.VMTypes.RelocateSpec	spec
	)

Relocates a virtual machine based on the specification.

The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.

. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgument	if any of the specified parameters are invalid.
vmware.vapi.std.errors.NotFound	if any of the resources specified in spec or the given "vm" could not be found
vmware.vapi.std.errors.ResourceInaccessible	if a specified resource (eg. host) is not accessible.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `Resource.ColdMigrate` . The resource `ResourcePool` referenced by the attribute VM.RelocatePlacementSpec.resourcePool requires `Resource.AssignVMToPool` .

Parameters:

vm	Existing Virtual machine to relocate. The parameter must be an identifier for the resource type: `VirtualMachine` .
spec	Relocate specification.

Implemented in vmware::vcenter::VMStub.

void vmware::vcenter::VM::Unregister ( string vm )

Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage.

All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. This method was added in vSphere API 6.8.7.

Exceptions:

vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is running (powered on).
vmware.vapi.std.errors.NotFound	if there is no virtual machine associated with vm in the system.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `VirtualMachine.Inventory.Unregister` .

Parameters:

vm	Identifier of the virtual machine to be unregistered. The parameter must be an identifier for the resource type: `VirtualMachine` .

Implemented in vmware::vcenter::VMStub.

void vmware::vcenter::VM::Unregister	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage.

All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. This method was added in vSphere API 6.8.7.

Exceptions:

vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is running (powered on).
vmware.vapi.std.errors.NotFound	if there is no virtual machine associated with vm in the system.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `VirtualMachine.Inventory.Unregister` .

Parameters:

vm	Identifier of the virtual machine to be unregistered. The parameter must be an identifier for the resource type: `VirtualMachine` .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task vmware::vcenter::VM::UnregisterAsync	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage.

All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. This method was added in vSphere API 6.8.7.

Exceptions:

vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is running (powered on).
vmware.vapi.std.errors.NotFound	if there is no virtual machine associated with vm in the system.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `VirtualMachine.Inventory.Unregister` .

Parameters:

vm	Identifier of the virtual machine to be unregistered. The parameter must be an identifier for the resource type: `VirtualMachine` .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::VMStub.

global::System.Threading.Tasks.Task vmware::vcenter::VM::UnregisterAsync ( string vm )

Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine's files from storage.

All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. This method was added in vSphere API 6.8.7.

Exceptions:

vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is running (powered on).
vmware.vapi.std.errors.NotFound	if there is no virtual machine associated with vm in the system.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: The resource `VirtualMachine` referenced by the parameter vm requires `VirtualMachine.Inventory.Unregister` .

Parameters:

vm	Identifier of the virtual machine to be unregistered. The parameter must be an identifier for the resource type: `VirtualMachine` .

Implemented in vmware::vcenter::VMStub.

The documentation for this interface was generated from the following file:

VM.cs

Public Member Functions

Detailed Description

Member Function Documentation