NvmeTypes.CreateSpec, NvmeTypes.Info, NvmeTypes.Summary
_VAPI_SERVICE_ID, RESOURCE_TYPE
Modifier and Type | Method and Description |
---|---|
java.lang.String |
create(java.lang.String vm,
NvmeTypes.CreateSpec spec)
Adds a virtual NVMe adapter to the virtual machine.
|
void |
create(java.lang.String vm,
NvmeTypes.CreateSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Adds a virtual NVMe adapter to the virtual machine.
|
void |
create(java.lang.String vm,
NvmeTypes.CreateSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Adds a virtual NVMe adapter to the virtual machine.
|
java.lang.String |
create(java.lang.String vm,
NvmeTypes.CreateSpec spec,
InvocationConfig invocationConfig)
Adds a virtual NVMe adapter to the virtual machine.
|
void |
delete(java.lang.String vm,
java.lang.String adapter)
Removes a virtual NVMe adapter from the virtual machine.
|
void |
delete(java.lang.String vm,
java.lang.String adapter,
AsyncCallback<java.lang.Void> asyncCallback)
Removes a virtual NVMe adapter from the virtual machine.
|
void |
delete(java.lang.String vm,
java.lang.String adapter,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Removes a virtual NVMe adapter from the virtual machine.
|
void |
delete(java.lang.String vm,
java.lang.String adapter,
InvocationConfig invocationConfig)
Removes a virtual NVMe adapter from the virtual machine.
|
NvmeTypes.Info |
get(java.lang.String vm,
java.lang.String adapter)
Returns information about a virtual NVMe adapter.
|
void |
get(java.lang.String vm,
java.lang.String adapter,
AsyncCallback<NvmeTypes.Info> asyncCallback)
Returns information about a virtual NVMe adapter.
|
void |
get(java.lang.String vm,
java.lang.String adapter,
AsyncCallback<NvmeTypes.Info> asyncCallback,
InvocationConfig invocationConfig)
Returns information about a virtual NVMe adapter.
|
NvmeTypes.Info |
get(java.lang.String vm,
java.lang.String adapter,
InvocationConfig invocationConfig)
Returns information about a virtual NVMe adapter.
|
java.util.List<NvmeTypes.Summary> |
list(java.lang.String vm)
Returns commonly used information about the virtual NVMe adapters belonging to
the virtual machine.
|
void |
list(java.lang.String vm,
AsyncCallback<java.util.List<NvmeTypes.Summary>> asyncCallback)
Returns commonly used information about the virtual NVMe adapters belonging to
the virtual machine.
|
void |
list(java.lang.String vm,
AsyncCallback<java.util.List<NvmeTypes.Summary>> asyncCallback,
InvocationConfig invocationConfig)
Returns commonly used information about the virtual NVMe adapters belonging to
the virtual machine.
|
java.util.List<NvmeTypes.Summary> |
list(java.lang.String vm,
InvocationConfig invocationConfig)
Returns commonly used information about the virtual NVMe adapters belonging to
the virtual machine.
|
java.util.List<NvmeTypes.Summary> list(java.lang.String vm)
Synchronous method overload. Result of the invocation will be reported as a method return value.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.Error
- if the system reports an error while responding to the request.NotFound
- if the virtual machine is not found.ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.Unauthenticated
- if the user can not be authenticated.Unauthorized
- if the user doesn't have the required privileges.java.util.List<NvmeTypes.Summary> list(java.lang.String vm, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.invocationConfig
- Configuration for the method invocation.Error
- if the system reports an error while responding to the request.NotFound
- if the virtual machine is not found.ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.Unauthenticated
- if the user can not be authenticated.Unauthorized
- if the user doesn't have the required privileges.void list(java.lang.String vm, AsyncCallback<java.util.List<NvmeTypes.Summary>> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
List of commonly used information about virtual NVMe adapters.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine is not found.
ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void list(java.lang.String vm, AsyncCallback<java.util.List<NvmeTypes.Summary>> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
List of commonly used information about virtual NVMe adapters.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine is not found.
ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.NvmeTypes.Info get(java.lang.String vm, java.lang.String adapter)
Synchronous method overload. Result of the invocation will be reported as a method return value.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.adapter
- Virtual NVMe adapter identifier.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter
.Error
- if the system reports an error while responding to the request.NotFound
- if the virtual machine or virtual NVMe adapter is not found.ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.Unauthenticated
- if the user can not be authenticated.Unauthorized
- if the user doesn't have the required privileges.NvmeTypes.Info get(java.lang.String vm, java.lang.String adapter, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.adapter
- Virtual NVMe adapter identifier.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter
.invocationConfig
- Configuration for the method invocation.Error
- if the system reports an error while responding to the request.NotFound
- if the virtual machine or virtual NVMe adapter is not found.ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.Unauthenticated
- if the user can not be authenticated.Unauthorized
- if the user doesn't have the required privileges.void get(java.lang.String vm, java.lang.String adapter, AsyncCallback<NvmeTypes.Info> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Information about the specified virtual NVMe adapter.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine or virtual NVMe adapter is not found.
ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.adapter
- Virtual NVMe adapter identifier.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void get(java.lang.String vm, java.lang.String adapter, AsyncCallback<NvmeTypes.Info> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
Information about the specified virtual NVMe adapter.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotFound
- if the virtual machine or virtual NVMe adapter is not found.
ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.adapter
- Virtual NVMe adapter identifier.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String create(java.lang.String vm, NvmeTypes.CreateSpec spec)
Synchronous method overload. Result of the invocation will be reported as a method return value.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.spec
- Specification for the new virtual NVMe adapter.com.vmware.vcenter.vm.hardware.NvmeAdapter
.Error
- if the system reports an error while responding to the request.Error
- if the system reported that the NVMe adapter was created but was unable to
confirm the creation because the identifier of the new adapter could not be
determined.NotAllowedInCurrentState
- if the virtual machine is suspendedNotFound
- if the virtual machine is not found.UnableToAllocateResource
- if there are no more available NVMe buses on the virtual machine.ResourceInUse
- if the specified NVMe bus or PCI address is in use.InvalidArgument
- if the specified NVMe bus or PCI address is out of bounds.ResourceBusy
- if the virtual machine is busy performing another operation.ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.Unauthenticated
- if the user can not be authenticated.Unauthorized
- if the user doesn't have the required privileges.Unsupported
- if the guest operating system of the virtual machine is not supported and spec
includes null
properties that default to guest-specific values.java.lang.String create(java.lang.String vm, NvmeTypes.CreateSpec spec, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.spec
- Specification for the new virtual NVMe adapter.invocationConfig
- Configuration for the method invocation.com.vmware.vcenter.vm.hardware.NvmeAdapter
.Error
- if the system reports an error while responding to the request.Error
- if the system reported that the NVMe adapter was created but was unable to
confirm the creation because the identifier of the new adapter could not be
determined.NotAllowedInCurrentState
- if the virtual machine is suspendedNotFound
- if the virtual machine is not found.UnableToAllocateResource
- if there are no more available NVMe buses on the virtual machine.ResourceInUse
- if the specified NVMe bus or PCI address is in use.InvalidArgument
- if the specified NVMe bus or PCI address is out of bounds.ResourceBusy
- if the virtual machine is busy performing another operation.ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.Unauthenticated
- if the user can not be authenticated.Unauthorized
- if the user doesn't have the required privileges.Unsupported
- if the guest operating system of the virtual machine is not supported and spec
includes null
properties that default to guest-specific values.void create(java.lang.String vm, NvmeTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Virtual NVMe adapter identifier.
The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter
.
Operation Errors:
Error
- if the system reports an error while responding to the request.
Error
- if the system reported that the NVMe adapter was created but was unable to
confirm the creation because the identifier of the new adapter could not be
determined.
NotAllowedInCurrentState
- if the virtual machine is suspended
NotFound
- if the virtual machine is not found.
UnableToAllocateResource
- if there are no more available NVMe buses on the virtual machine.
ResourceInUse
- if the specified NVMe bus or PCI address is in use.
InvalidArgument
- if the specified NVMe bus or PCI address is out of bounds.
ResourceBusy
- if the virtual machine is busy performing another operation.
ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
Unsupported
- if the guest operating system of the virtual machine is not supported and spec
includes null
properties that default to guest-specific values.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.spec
- Specification for the new virtual NVMe adapter.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void create(java.lang.String vm, NvmeTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
Virtual NVMe adapter identifier.
The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter
.
Operation Errors:
Error
- if the system reports an error while responding to the request.
Error
- if the system reported that the NVMe adapter was created but was unable to
confirm the creation because the identifier of the new adapter could not be
determined.
NotAllowedInCurrentState
- if the virtual machine is suspended
NotFound
- if the virtual machine is not found.
UnableToAllocateResource
- if there are no more available NVMe buses on the virtual machine.
ResourceInUse
- if the specified NVMe bus or PCI address is in use.
InvalidArgument
- if the specified NVMe bus or PCI address is out of bounds.
ResourceBusy
- if the virtual machine is busy performing another operation.
ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
Unsupported
- if the guest operating system of the virtual machine is not supported and spec
includes null
properties that default to guest-specific values.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.spec
- Specification for the new virtual NVMe adapter.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void delete(java.lang.String vm, java.lang.String adapter)
Synchronous method overload. Result of the invocation will be reported as a method return value.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.adapter
- Virtual NVMe adapter identifier.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter
.Error
- if the system reports an error while responding to the request.NotAllowedInCurrentState
- if the virtual machine is suspendedNotFound
- if the virtual machine or virtual NVMe adapter is not found.ResourceBusy
- if the virtual machine is busy performing another operation.ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.Unauthenticated
- if the user can not be authenticated.Unauthorized
- if the user doesn't have the required privileges.void delete(java.lang.String vm, java.lang.String adapter, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.adapter
- Virtual NVMe adapter identifier.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter
.invocationConfig
- Configuration for the method invocation.Error
- if the system reports an error while responding to the request.NotAllowedInCurrentState
- if the virtual machine is suspendedNotFound
- if the virtual machine or virtual NVMe adapter is not found.ResourceBusy
- if the virtual machine is busy performing another operation.ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.Unauthenticated
- if the user can not be authenticated.Unauthorized
- if the user doesn't have the required privileges.void delete(java.lang.String vm, java.lang.String adapter, AsyncCallback<java.lang.Void> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotAllowedInCurrentState
- if the virtual machine is suspended
NotFound
- if the virtual machine or virtual NVMe adapter is not found.
ResourceBusy
- if the virtual machine is busy performing another operation.
ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.adapter
- Virtual NVMe adapter identifier.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void delete(java.lang.String vm, java.lang.String adapter, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Operation Errors:
Error
- if the system reports an error while responding to the request.
NotAllowedInCurrentState
- if the virtual machine is suspended
NotFound
- if the virtual machine or virtual NVMe adapter is not found.
ResourceBusy
- if the virtual machine is busy performing another operation.
ResourceInaccessible
- if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable
- if the system is unable to communicate with a service to complete the request.
Unauthenticated
- if the user can not be authenticated.
Unauthorized
- if the user doesn't have the required privileges.
vm
- Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine
.adapter
- Virtual NVMe adapter identifier.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.