VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::vcenter::vm_template::LibraryItemsStub Class Reference

Remote stub implementation of the LibraryItems API service. More...

Inherits vmware::vcenter::vm_template::LibraryItems.

List of all members.

Public Member Functions

 LibraryItemsStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
 LibraryItemsStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
string Create (vmware.vcenter.vm_template.LibraryItemsTypes.CreateSpec spec)
 Creates a library item in content library from a virtual machine.
string Create (vmware.vcenter.vm_template.LibraryItemsTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Creates a library item in content library from a virtual machine.
global::System.Threading.Tasks.Task
< string > 
CreateAsync (vmware.vcenter.vm_template.LibraryItemsTypes.CreateSpec spec)
 Creates a library item in content library from a virtual machine.
global::System.Threading.Tasks.Task
< string > 
CreateAsync (vmware.vcenter.vm_template.LibraryItemsTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Creates a library item in content library from a virtual machine.
string Deploy (string templateLibraryItem, vmware.vcenter.vm_template.LibraryItemsTypes.DeploySpec spec)
 Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem .
string Deploy (string templateLibraryItem, vmware.vcenter.vm_template.LibraryItemsTypes.DeploySpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem .
global::System.Threading.Tasks.Task
< string > 
DeployAsync (string templateLibraryItem, vmware.vcenter.vm_template.LibraryItemsTypes.DeploySpec spec)
 Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem .
global::System.Threading.Tasks.Task
< string > 
DeployAsync (string templateLibraryItem, vmware.vcenter.vm_template.LibraryItemsTypes.DeploySpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem .
vmware.vcenter.vm_template.LibraryItemsTypes.Info Get (string templateLibraryItem)
 Returns information about a virtual machine template contained in the library item specified by templateLibraryItem .
vmware.vcenter.vm_template.LibraryItemsTypes.Info Get (string templateLibraryItem, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about a virtual machine template contained in the library item specified by templateLibraryItem .
global::System.Threading.Tasks.Task
< vmware.vcenter.vm_template.LibraryItemsTypes.Info
GetAsync (string templateLibraryItem)
 Returns information about a virtual machine template contained in the library item specified by templateLibraryItem .
global::System.Threading.Tasks.Task
< vmware.vcenter.vm_template.LibraryItemsTypes.Info
GetAsync (string templateLibraryItem, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about a virtual machine template contained in the library item specified by templateLibraryItem .

Detailed Description

Remote stub implementation of the LibraryItems API service.


Constructor & Destructor Documentation

vmware::vcenter::vm_template::LibraryItemsStub::LibraryItemsStub ( vmware.vapi.core.IApiProvider  iApiProvider,
vmware.vapi.bindings.TypeConverter  typeConverter,
vmware.vapi.bindings.IStubConfiguration  config 
) [inline]
vmware::vcenter::vm_template::LibraryItemsStub::LibraryItemsStub ( vmware.vapi.core.IApiProvider  iApiProvider,
vmware.vapi.bindings.IStubConfiguration  config 
) [inline]

Member Function Documentation

string vmware::vcenter::vm_template::LibraryItemsStub::Create ( vmware.vcenter.vm_template.LibraryItemsTypes.CreateSpec  spec) [inline]

Creates a library item in content library from a virtual machine.

This method creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. This method was added in vSphere API 6.8.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif an entity with the name specified by LibraryItems.CreateSpec.name already exists in the folder specified by LibraryItems.CreatePlacementSpec.folder
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgumentif LibraryItems.CreateSpec contains invalid arguments.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the operation cannot be performed because of the source virtual machine's current state.
vmware.vapi.std.errors.NotFoundif the source virtual machine specified by LibraryItems.CreateSpec.sourceVm does not exist.
vmware.vapi.std.errors.NotFoundif the library specified by LibraryItems.CreateSpec.library does not exist.
vmware.vapi.std.errors.ResourceInaccessibleif there was an error accessing a file from the source virtual machine.
vmware.vapi.std.errors.ResourceInUseif the source virtual machine is busy.
vmware.vapi.std.errors.ServiceUnavailableif any of the services involved in the method are unavailable.
vmware.vapi.std.errors.UnableToAllocateResourceif any of the resources needed to create the virtual machine template could not be allocated.
vmware.vapi.std.errors.Unauthenticatedif the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
  • The resource com.vmware.content.Library referenced by the attribute LibraryItems.CreateSpec.library requires ContentLibrary.AddLibraryItem .
  • The resource VirtualMachine referenced by the attribute LibraryItems.CreateSpec.sourceVm requires System.Read .
  • The resource Datastore referenced by the attribute LibraryItems.CreateSpecVmHomeStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecVmHomeStoragePolicy.policy requires System.Read .
  • The resource Datastore referenced by the attribute LibraryItems.CreateSpecDiskStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecDiskStoragePolicy.policy requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.CreateSpec.diskStorageOverrides requires System.Read .
  • The resource Folder referenced by the attribute LibraryItems.CreatePlacementSpec.folder requires System.Read .
  • The resource ResourcePool referenced by the attribute LibraryItems.CreatePlacementSpec.resourcePool requires System.Read .
  • The resource HostSystem referenced by the attribute LibraryItems.CreatePlacementSpec.host requires System.Read .
  • The resource ClusterComputeResource referenced by the attribute LibraryItems.CreatePlacementSpec.cluster requires System.Read .
Parameters:
specinformation used to create the library item from the source virtual machine.
Returns:
Identifier of the newly created library item. The result will be an identifier for the resource type: com.vmware.content.library.Item .

Implements vmware::vcenter::vm_template::LibraryItems.

string vmware::vcenter::vm_template::LibraryItemsStub::Create ( vmware.vcenter.vm_template.LibraryItemsTypes.CreateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Creates a library item in content library from a virtual machine.

This method creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. This method was added in vSphere API 6.8.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif an entity with the name specified by LibraryItems.CreateSpec.name already exists in the folder specified by LibraryItems.CreatePlacementSpec.folder
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgumentif LibraryItems.CreateSpec contains invalid arguments.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the operation cannot be performed because of the source virtual machine's current state.
vmware.vapi.std.errors.NotFoundif the source virtual machine specified by LibraryItems.CreateSpec.sourceVm does not exist.
vmware.vapi.std.errors.NotFoundif the library specified by LibraryItems.CreateSpec.library does not exist.
vmware.vapi.std.errors.ResourceInaccessibleif there was an error accessing a file from the source virtual machine.
vmware.vapi.std.errors.ResourceInUseif the source virtual machine is busy.
vmware.vapi.std.errors.ServiceUnavailableif any of the services involved in the method are unavailable.
vmware.vapi.std.errors.UnableToAllocateResourceif any of the resources needed to create the virtual machine template could not be allocated.
vmware.vapi.std.errors.Unauthenticatedif the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
  • The resource com.vmware.content.Library referenced by the attribute LibraryItems.CreateSpec.library requires ContentLibrary.AddLibraryItem .
  • The resource VirtualMachine referenced by the attribute LibraryItems.CreateSpec.sourceVm requires System.Read .
  • The resource Datastore referenced by the attribute LibraryItems.CreateSpecVmHomeStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecVmHomeStoragePolicy.policy requires System.Read .
  • The resource Datastore referenced by the attribute LibraryItems.CreateSpecDiskStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecDiskStoragePolicy.policy requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.CreateSpec.diskStorageOverrides requires System.Read .
  • The resource Folder referenced by the attribute LibraryItems.CreatePlacementSpec.folder requires System.Read .
  • The resource ResourcePool referenced by the attribute LibraryItems.CreatePlacementSpec.resourcePool requires System.Read .
  • The resource HostSystem referenced by the attribute LibraryItems.CreatePlacementSpec.host requires System.Read .
  • The resource ClusterComputeResource referenced by the attribute LibraryItems.CreatePlacementSpec.cluster requires System.Read .
Parameters:
specinformation used to create the library item from the source virtual machine.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Identifier of the newly created library item. The result will be an identifier for the resource type: com.vmware.content.library.Item .

Implements vmware::vcenter::vm_template::LibraryItems.

global::System.Threading.Tasks.Task<string> vmware::vcenter::vm_template::LibraryItemsStub::CreateAsync ( vmware.vcenter.vm_template.LibraryItemsTypes.CreateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Creates a library item in content library from a virtual machine.

This method creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. This method was added in vSphere API 6.8.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif an entity with the name specified by LibraryItems.CreateSpec.name already exists in the folder specified by LibraryItems.CreatePlacementSpec.folder
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgumentif LibraryItems.CreateSpec contains invalid arguments.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the operation cannot be performed because of the source virtual machine's current state.
vmware.vapi.std.errors.NotFoundif the source virtual machine specified by LibraryItems.CreateSpec.sourceVm does not exist.
vmware.vapi.std.errors.NotFoundif the library specified by LibraryItems.CreateSpec.library does not exist.
vmware.vapi.std.errors.ResourceInaccessibleif there was an error accessing a file from the source virtual machine.
vmware.vapi.std.errors.ResourceInUseif the source virtual machine is busy.
vmware.vapi.std.errors.ServiceUnavailableif any of the services involved in the method are unavailable.
vmware.vapi.std.errors.UnableToAllocateResourceif any of the resources needed to create the virtual machine template could not be allocated.
vmware.vapi.std.errors.Unauthenticatedif the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
  • The resource com.vmware.content.Library referenced by the attribute LibraryItems.CreateSpec.library requires ContentLibrary.AddLibraryItem .
  • The resource VirtualMachine referenced by the attribute LibraryItems.CreateSpec.sourceVm requires System.Read .
  • The resource Datastore referenced by the attribute LibraryItems.CreateSpecVmHomeStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecVmHomeStoragePolicy.policy requires System.Read .
  • The resource Datastore referenced by the attribute LibraryItems.CreateSpecDiskStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecDiskStoragePolicy.policy requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.CreateSpec.diskStorageOverrides requires System.Read .
  • The resource Folder referenced by the attribute LibraryItems.CreatePlacementSpec.folder requires System.Read .
  • The resource ResourcePool referenced by the attribute LibraryItems.CreatePlacementSpec.resourcePool requires System.Read .
  • The resource HostSystem referenced by the attribute LibraryItems.CreatePlacementSpec.host requires System.Read .
  • The resource ClusterComputeResource referenced by the attribute LibraryItems.CreatePlacementSpec.cluster requires System.Read .
Parameters:
specinformation used to create the library item from the source virtual machine.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Identifier of the newly created library item. The result will be an identifier for the resource type: com.vmware.content.library.Item .

Implements vmware::vcenter::vm_template::LibraryItems.

global::System.Threading.Tasks.Task<string> vmware::vcenter::vm_template::LibraryItemsStub::CreateAsync ( vmware.vcenter.vm_template.LibraryItemsTypes.CreateSpec  spec) [inline]

Creates a library item in content library from a virtual machine.

This method creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. This method was added in vSphere API 6.8.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif an entity with the name specified by LibraryItems.CreateSpec.name already exists in the folder specified by LibraryItems.CreatePlacementSpec.folder
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgumentif LibraryItems.CreateSpec contains invalid arguments.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the operation cannot be performed because of the source virtual machine's current state.
vmware.vapi.std.errors.NotFoundif the source virtual machine specified by LibraryItems.CreateSpec.sourceVm does not exist.
vmware.vapi.std.errors.NotFoundif the library specified by LibraryItems.CreateSpec.library does not exist.
vmware.vapi.std.errors.ResourceInaccessibleif there was an error accessing a file from the source virtual machine.
vmware.vapi.std.errors.ResourceInUseif the source virtual machine is busy.
vmware.vapi.std.errors.ServiceUnavailableif any of the services involved in the method are unavailable.
vmware.vapi.std.errors.UnableToAllocateResourceif any of the resources needed to create the virtual machine template could not be allocated.
vmware.vapi.std.errors.Unauthenticatedif the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
  • The resource com.vmware.content.Library referenced by the attribute LibraryItems.CreateSpec.library requires ContentLibrary.AddLibraryItem .
  • The resource VirtualMachine referenced by the attribute LibraryItems.CreateSpec.sourceVm requires System.Read .
  • The resource Datastore referenced by the attribute LibraryItems.CreateSpecVmHomeStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecVmHomeStoragePolicy.policy requires System.Read .
  • The resource Datastore referenced by the attribute LibraryItems.CreateSpecDiskStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecDiskStoragePolicy.policy requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.CreateSpec.diskStorageOverrides requires System.Read .
  • The resource Folder referenced by the attribute LibraryItems.CreatePlacementSpec.folder requires System.Read .
  • The resource ResourcePool referenced by the attribute LibraryItems.CreatePlacementSpec.resourcePool requires System.Read .
  • The resource HostSystem referenced by the attribute LibraryItems.CreatePlacementSpec.host requires System.Read .
  • The resource ClusterComputeResource referenced by the attribute LibraryItems.CreatePlacementSpec.cluster requires System.Read .
Parameters:
specinformation used to create the library item from the source virtual machine.
Returns:
Identifier of the newly created library item. The result will be an identifier for the resource type: com.vmware.content.library.Item .

Implements vmware::vcenter::vm_template::LibraryItems.

string vmware::vcenter::vm_template::LibraryItemsStub::Deploy ( string  templateLibraryItem,
vmware.vcenter.vm_template.LibraryItemsTypes.DeploySpec  spec 
) [inline]

Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem .

It uses the deployment specification in spec . If LibraryItems.DeploySpec.poweredOn and/or LibraryItems.DeploySpec.guestCustomization are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. This method was added in vSphere API 6.8.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif a virtual machine with the name specified by LibraryItems.DeploySpec.name already exists.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgumentif spec contains invalid arguments.
vmware.vapi.std.errors.NotAllowedInCurrentStateif either a specified host or a specified datastore is in an invalid state for the deployment, such as maintenance mode.
vmware.vapi.std.errors.NotFoundif the library item specified by templateLibraryItem cannot be found.
vmware.vapi.std.errors.NotFoundif any resource specified by a field of the LibraryItems.DeploySpec class, specified by spec cannot be found.
vmware.vapi.std.errors.ResourceInaccessibleif there was an error accessing the source virtual machine template contained in the library item specified by templateLibraryItem .
vmware.vapi.std.errors.ResourceInaccessibleif there an error accessing any of the resources specified in the spec .
vmware.vapi.std.errors.ServiceUnavailableif any of the services involved in the method are unavailable.
vmware.vapi.std.errors.UnableToAllocateResourceif there was an error in allocating any of the resources required by the method.
vmware.vapi.std.errors.Unauthenticatedif the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
  • The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires VirtualMachine.Provisioning.DeployTemplate .
  • The resource Datastore referenced by the attribute LibraryItems.DeploySpecVmHomeStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecVmHomeStoragePolicy.policy requires System.Read .
  • The resource Datastore referenced by the attribute LibraryItems.DeploySpecDiskStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecDiskStoragePolicy.policy requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.DeploySpec.diskStorageOverrides requires System.Read .
  • The resource Folder referenced by the attribute LibraryItems.DeployPlacementSpec.folder requires System.Read .
  • The resource ResourcePool referenced by the attribute LibraryItems.DeployPlacementSpec.resourcePool requires System.Read .
  • The resource HostSystem referenced by the attribute LibraryItems.DeployPlacementSpec.host requires System.Read .
  • The resource ClusterComputeResource referenced by the attribute LibraryItems.DeployPlacementSpec.cluster requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.nics requires System.Read .
  • The resource Network referenced by the attribute LibraryItems.EthernetUpdateSpec.network requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the attribute LibraryItems.HardwareCustomizationSpec.disksToRemove requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.disksToUpdate requires System.Read .
Parameters:
templateLibraryItemidentifier of the content library item containing the source virtual machine template to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
specspecification of how the virtual machine should be deployed.
Returns:
Identifier of the deployed virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implements vmware::vcenter::vm_template::LibraryItems.

string vmware::vcenter::vm_template::LibraryItemsStub::Deploy ( string  templateLibraryItem,
vmware.vcenter.vm_template.LibraryItemsTypes.DeploySpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem .

It uses the deployment specification in spec . If LibraryItems.DeploySpec.poweredOn and/or LibraryItems.DeploySpec.guestCustomization are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. This method was added in vSphere API 6.8.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif a virtual machine with the name specified by LibraryItems.DeploySpec.name already exists.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgumentif spec contains invalid arguments.
vmware.vapi.std.errors.NotAllowedInCurrentStateif either a specified host or a specified datastore is in an invalid state for the deployment, such as maintenance mode.
vmware.vapi.std.errors.NotFoundif the library item specified by templateLibraryItem cannot be found.
vmware.vapi.std.errors.NotFoundif any resource specified by a field of the LibraryItems.DeploySpec class, specified by spec cannot be found.
vmware.vapi.std.errors.ResourceInaccessibleif there was an error accessing the source virtual machine template contained in the library item specified by templateLibraryItem .
vmware.vapi.std.errors.ResourceInaccessibleif there an error accessing any of the resources specified in the spec .
vmware.vapi.std.errors.ServiceUnavailableif any of the services involved in the method are unavailable.
vmware.vapi.std.errors.UnableToAllocateResourceif there was an error in allocating any of the resources required by the method.
vmware.vapi.std.errors.Unauthenticatedif the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
  • The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires VirtualMachine.Provisioning.DeployTemplate .
  • The resource Datastore referenced by the attribute LibraryItems.DeploySpecVmHomeStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecVmHomeStoragePolicy.policy requires System.Read .
  • The resource Datastore referenced by the attribute LibraryItems.DeploySpecDiskStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecDiskStoragePolicy.policy requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.DeploySpec.diskStorageOverrides requires System.Read .
  • The resource Folder referenced by the attribute LibraryItems.DeployPlacementSpec.folder requires System.Read .
  • The resource ResourcePool referenced by the attribute LibraryItems.DeployPlacementSpec.resourcePool requires System.Read .
  • The resource HostSystem referenced by the attribute LibraryItems.DeployPlacementSpec.host requires System.Read .
  • The resource ClusterComputeResource referenced by the attribute LibraryItems.DeployPlacementSpec.cluster requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.nics requires System.Read .
  • The resource Network referenced by the attribute LibraryItems.EthernetUpdateSpec.network requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the attribute LibraryItems.HardwareCustomizationSpec.disksToRemove requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.disksToUpdate requires System.Read .
Parameters:
templateLibraryItemidentifier of the content library item containing the source virtual machine template to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
specspecification of how the virtual machine should be deployed.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Identifier of the deployed virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implements vmware::vcenter::vm_template::LibraryItems.

global::System.Threading.Tasks.Task<string> vmware::vcenter::vm_template::LibraryItemsStub::DeployAsync ( string  templateLibraryItem,
vmware.vcenter.vm_template.LibraryItemsTypes.DeploySpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem .

It uses the deployment specification in spec . If LibraryItems.DeploySpec.poweredOn and/or LibraryItems.DeploySpec.guestCustomization are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. This method was added in vSphere API 6.8.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif a virtual machine with the name specified by LibraryItems.DeploySpec.name already exists.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgumentif spec contains invalid arguments.
vmware.vapi.std.errors.NotAllowedInCurrentStateif either a specified host or a specified datastore is in an invalid state for the deployment, such as maintenance mode.
vmware.vapi.std.errors.NotFoundif the library item specified by templateLibraryItem cannot be found.
vmware.vapi.std.errors.NotFoundif any resource specified by a field of the LibraryItems.DeploySpec class, specified by spec cannot be found.
vmware.vapi.std.errors.ResourceInaccessibleif there was an error accessing the source virtual machine template contained in the library item specified by templateLibraryItem .
vmware.vapi.std.errors.ResourceInaccessibleif there an error accessing any of the resources specified in the spec .
vmware.vapi.std.errors.ServiceUnavailableif any of the services involved in the method are unavailable.
vmware.vapi.std.errors.UnableToAllocateResourceif there was an error in allocating any of the resources required by the method.
vmware.vapi.std.errors.Unauthenticatedif the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
  • The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires VirtualMachine.Provisioning.DeployTemplate .
  • The resource Datastore referenced by the attribute LibraryItems.DeploySpecVmHomeStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecVmHomeStoragePolicy.policy requires System.Read .
  • The resource Datastore referenced by the attribute LibraryItems.DeploySpecDiskStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecDiskStoragePolicy.policy requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.DeploySpec.diskStorageOverrides requires System.Read .
  • The resource Folder referenced by the attribute LibraryItems.DeployPlacementSpec.folder requires System.Read .
  • The resource ResourcePool referenced by the attribute LibraryItems.DeployPlacementSpec.resourcePool requires System.Read .
  • The resource HostSystem referenced by the attribute LibraryItems.DeployPlacementSpec.host requires System.Read .
  • The resource ClusterComputeResource referenced by the attribute LibraryItems.DeployPlacementSpec.cluster requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.nics requires System.Read .
  • The resource Network referenced by the attribute LibraryItems.EthernetUpdateSpec.network requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the attribute LibraryItems.HardwareCustomizationSpec.disksToRemove requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.disksToUpdate requires System.Read .
Parameters:
templateLibraryItemidentifier of the content library item containing the source virtual machine template to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
specspecification of how the virtual machine should be deployed.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Identifier of the deployed virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implements vmware::vcenter::vm_template::LibraryItems.

global::System.Threading.Tasks.Task<string> vmware::vcenter::vm_template::LibraryItemsStub::DeployAsync ( string  templateLibraryItem,
vmware.vcenter.vm_template.LibraryItemsTypes.DeploySpec  spec 
) [inline]

Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem .

It uses the deployment specification in spec . If LibraryItems.DeploySpec.poweredOn and/or LibraryItems.DeploySpec.guestCustomization are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. This method was added in vSphere API 6.8.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif a virtual machine with the name specified by LibraryItems.DeploySpec.name already exists.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidArgumentif spec contains invalid arguments.
vmware.vapi.std.errors.NotAllowedInCurrentStateif either a specified host or a specified datastore is in an invalid state for the deployment, such as maintenance mode.
vmware.vapi.std.errors.NotFoundif the library item specified by templateLibraryItem cannot be found.
vmware.vapi.std.errors.NotFoundif any resource specified by a field of the LibraryItems.DeploySpec class, specified by spec cannot be found.
vmware.vapi.std.errors.ResourceInaccessibleif there was an error accessing the source virtual machine template contained in the library item specified by templateLibraryItem .
vmware.vapi.std.errors.ResourceInaccessibleif there an error accessing any of the resources specified in the spec .
vmware.vapi.std.errors.ServiceUnavailableif any of the services involved in the method are unavailable.
vmware.vapi.std.errors.UnableToAllocateResourceif there was an error in allocating any of the resources required by the method.
vmware.vapi.std.errors.Unauthenticatedif the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
  • The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires VirtualMachine.Provisioning.DeployTemplate .
  • The resource Datastore referenced by the attribute LibraryItems.DeploySpecVmHomeStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecVmHomeStoragePolicy.policy requires System.Read .
  • The resource Datastore referenced by the attribute LibraryItems.DeploySpecDiskStorage.datastore requires System.Read .
  • The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecDiskStoragePolicy.policy requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.DeploySpec.diskStorageOverrides requires System.Read .
  • The resource Folder referenced by the attribute LibraryItems.DeployPlacementSpec.folder requires System.Read .
  • The resource ResourcePool referenced by the attribute LibraryItems.DeployPlacementSpec.resourcePool requires System.Read .
  • The resource HostSystem referenced by the attribute LibraryItems.DeployPlacementSpec.host requires System.Read .
  • The resource ClusterComputeResource referenced by the attribute LibraryItems.DeployPlacementSpec.cluster requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.nics requires System.Read .
  • The resource Network referenced by the attribute LibraryItems.EthernetUpdateSpec.network requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the attribute LibraryItems.HardwareCustomizationSpec.disksToRemove requires System.Read .
  • The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.disksToUpdate requires System.Read .
Parameters:
templateLibraryItemidentifier of the content library item containing the source virtual machine template to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
specspecification of how the virtual machine should be deployed.
Returns:
Identifier of the deployed virtual machine. The result will be an identifier for the resource type: VirtualMachine .

Implements vmware::vcenter::vm_template::LibraryItems.

vmware.vcenter.vm_template.LibraryItemsTypes.Info vmware::vcenter::vm_template::LibraryItemsStub::Get ( string  templateLibraryItem,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Returns information about a virtual machine template contained in the library item specified by templateLibraryItem .

This method was added in vSphere API 6.8.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the library item could not be found.
vmware.vapi.std.errors.ResourceInaccessibleif the virtual machine template's configuration state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailableif any of the services involved in the method are unavailable.
vmware.vapi.std.errors.Unauthenticatedif the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
  • The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read .
Parameters:
templateLibraryItemidentifier of the library item containing the virtual machine template. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Information about the virtual machine template item contained in the library item. If null, the library item specified by templateLibraryItem does not contain a virtual machine template.

Implements vmware::vcenter::vm_template::LibraryItems.

vmware.vcenter.vm_template.LibraryItemsTypes.Info vmware::vcenter::vm_template::LibraryItemsStub::Get ( string  templateLibraryItem) [inline]

Returns information about a virtual machine template contained in the library item specified by templateLibraryItem .

This method was added in vSphere API 6.8.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the library item could not be found.
vmware.vapi.std.errors.ResourceInaccessibleif the virtual machine template's configuration state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailableif any of the services involved in the method are unavailable.
vmware.vapi.std.errors.Unauthenticatedif the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
  • The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read .
Parameters:
templateLibraryItemidentifier of the library item containing the virtual machine template. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
Returns:
Information about the virtual machine template item contained in the library item. If null, the library item specified by templateLibraryItem does not contain a virtual machine template.

Implements vmware::vcenter::vm_template::LibraryItems.

global::System.Threading.Tasks.Task<vmware.vcenter.vm_template.LibraryItemsTypes.Info> vmware::vcenter::vm_template::LibraryItemsStub::GetAsync ( string  templateLibraryItem) [inline]

Returns information about a virtual machine template contained in the library item specified by templateLibraryItem .

This method was added in vSphere API 6.8.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the library item could not be found.
vmware.vapi.std.errors.ResourceInaccessibleif the virtual machine template's configuration state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailableif any of the services involved in the method are unavailable.
vmware.vapi.std.errors.Unauthenticatedif the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
  • The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read .
Parameters:
templateLibraryItemidentifier of the library item containing the virtual machine template. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
Returns:
Information about the virtual machine template item contained in the library item. If null, the library item specified by templateLibraryItem does not contain a virtual machine template.

Implements vmware::vcenter::vm_template::LibraryItems.

global::System.Threading.Tasks.Task<vmware.vcenter.vm_template.LibraryItemsTypes.Info> vmware::vcenter::vm_template::LibraryItemsStub::GetAsync ( string  templateLibraryItem,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Returns information about a virtual machine template contained in the library item specified by templateLibraryItem .

This method was added in vSphere API 6.8.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the library item could not be found.
vmware.vapi.std.errors.ResourceInaccessibleif the virtual machine template's configuration state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailableif any of the services involved in the method are unavailable.
vmware.vapi.std.errors.Unauthenticatedif the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
  • The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read .
Parameters:
templateLibraryItemidentifier of the library item containing the virtual machine template. The parameter must be an identifier for the resource type: com.vmware.content.library.Item .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Information about the virtual machine template item contained in the library item. If null, the library item specified by templateLibraryItem does not contain a virtual machine template.

Implements vmware::vcenter::vm_template::LibraryItems.


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