public interface BaseImages extends Service, BaseImagesTypes
BaseImages
interface provides methods to manage trusted instances of
ESX software on a cluster level. This interface was added in vSphere API 7.0.0.BaseImagesTypes._VAPI_OPERATIONS, BaseImagesTypes.FilterSpec, BaseImagesTypes.Health, BaseImagesTypes.Info, BaseImagesTypes.Summary
_VAPI_SERVICE_ID, RESOURCE_TYPE
Modifier and Type | Method and Description |
---|---|
java.lang.String |
delete_Task(java.lang.String cluster,
java.lang.String version)
Remove a trusted ESX base image of each ESX in the cluster.
|
void |
delete_Task(java.lang.String cluster,
java.lang.String version,
AsyncCallback<java.lang.String> asyncCallback)
Remove a trusted ESX base image of each ESX in the cluster.
|
void |
delete_Task(java.lang.String cluster,
java.lang.String version,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Remove a trusted ESX base image of each ESX in the cluster.
|
java.lang.String |
delete_Task(java.lang.String cluster,
java.lang.String version,
InvocationConfig invocationConfig)
Remove a trusted ESX base image of each ESX in the cluster.
|
java.lang.String |
get_Task(java.lang.String cluster,
java.lang.String version)
Get the trusted ESX base version details.
|
void |
get_Task(java.lang.String cluster,
java.lang.String version,
AsyncCallback<java.lang.String> asyncCallback)
Get the trusted ESX base version details.
|
void |
get_Task(java.lang.String cluster,
java.lang.String version,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Get the trusted ESX base version details.
|
java.lang.String |
get_Task(java.lang.String cluster,
java.lang.String version,
InvocationConfig invocationConfig)
Get the trusted ESX base version details.
|
java.lang.String |
importFromImgdb_Task(java.lang.String cluster,
byte[] imgdb)
Import ESX metadata as a new trusted base image to each host in the cluster.
|
void |
importFromImgdb_Task(java.lang.String cluster,
byte[] imgdb,
AsyncCallback<java.lang.String> asyncCallback)
Import ESX metadata as a new trusted base image to each host in the cluster.
|
void |
importFromImgdb_Task(java.lang.String cluster,
byte[] imgdb,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Import ESX metadata as a new trusted base image to each host in the cluster.
|
java.lang.String |
importFromImgdb_Task(java.lang.String cluster,
byte[] imgdb,
InvocationConfig invocationConfig)
Import ESX metadata as a new trusted base image to each host in the cluster.
|
java.lang.String |
list_Task(java.lang.String cluster,
BaseImagesTypes.FilterSpec spec)
Return a list of trusted ESX base images.
|
void |
list_Task(java.lang.String cluster,
BaseImagesTypes.FilterSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Return a list of trusted ESX base images.
|
void |
list_Task(java.lang.String cluster,
BaseImagesTypes.FilterSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Return a list of trusted ESX base images.
|
java.lang.String |
list_Task(java.lang.String cluster,
BaseImagesTypes.FilterSpec spec,
InvocationConfig invocationConfig)
Return a list of trusted ESX base images.
|
java.lang.String importFromImgdb_Task(java.lang.String cluster, byte[] imgdb)
Import a boot_imgdb.tgz file which contains metadata that describes a trusted ESX base image. A boot_imgdb.tgz file can be downloaded from a representative host.
. This method was added in vSphere API 7.0.0.Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.imgdb
- ESX metadata on a cluster level.AlreadyExists
- if ESX metadata for the same version has already been added.Error
- if there is a generic error.InvalidArgument
- if the imgdb is invalid or cluster id is empty.NotFound
- if the cluster is not found.Unauthenticated
- if the caller is not authenticated.java.lang.String importFromImgdb_Task(java.lang.String cluster, byte[] imgdb, InvocationConfig invocationConfig)
Import a boot_imgdb.tgz file which contains metadata that describes a trusted ESX base image. A boot_imgdb.tgz file can be downloaded from a representative host.
. This method was added in vSphere API 7.0.0.Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
Use invocationConfig
to specify configuration for this particular invocation.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.imgdb
- ESX metadata on a cluster level.invocationConfig
- Configuration for the method invocation.AlreadyExists
- if ESX metadata for the same version has already been added.Error
- if there is a generic error.InvalidArgument
- if the imgdb is invalid or cluster id is empty.NotFound
- if the cluster is not found.Unauthenticated
- if the caller is not authenticated.void importFromImgdb_Task(java.lang.String cluster, byte[] imgdb, AsyncCallback<java.lang.String> asyncCallback)
Import a boot_imgdb.tgz file which contains metadata that describes a trusted ESX base image. A boot_imgdb.tgz file can be downloaded from a representative host.
. This method was added in vSphere API 7.0.0.Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
AlreadyExists
- if ESX metadata for the same version has already been added.
Error
- if there is a generic error.
InvalidArgument
- if the imgdb is invalid or cluster id is empty.
NotFound
- if the cluster is not found.
Unauthenticated
- if the caller is not authenticated.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.imgdb
- ESX metadata on a cluster level.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void importFromImgdb_Task(java.lang.String cluster, byte[] imgdb, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Import a boot_imgdb.tgz file which contains metadata that describes a trusted ESX base image. A boot_imgdb.tgz file can be downloaded from a representative host.
. This method was added in vSphere API 7.0.0.Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
AlreadyExists
- if ESX metadata for the same version has already been added.
Error
- if there is a generic error.
InvalidArgument
- if the imgdb is invalid or cluster id is empty.
NotFound
- if the cluster is not found.
Unauthenticated
- if the caller is not authenticated.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.imgdb
- ESX metadata on a cluster level.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String list_Task(java.lang.String cluster, BaseImagesTypes.FilterSpec spec)
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.spec
- The search specification.
if return all information.Error
- if there is a generic error.InvalidArgument
- if the cluster id is empty.NotFound
- if the cluster is not found.Unauthenticated
- if the caller is not authenticated.java.lang.String list_Task(java.lang.String cluster, BaseImagesTypes.FilterSpec spec, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
Use invocationConfig
to specify configuration for this particular invocation.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.spec
- The search specification.
if return all information.invocationConfig
- Configuration for the method invocation.Error
- if there is a generic error.InvalidArgument
- if the cluster id is empty.NotFound
- if the cluster is not found.Unauthenticated
- if the caller is not authenticated.void list_Task(java.lang.String cluster, BaseImagesTypes.FilterSpec spec, AsyncCallback<java.lang.String> asyncCallback)
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Error
- if there is a generic error.
InvalidArgument
- if the cluster id is empty.
NotFound
- if the cluster is not found.
Unauthenticated
- if the caller is not authenticated.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.spec
- The search specification.
if return all information.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void list_Task(java.lang.String cluster, BaseImagesTypes.FilterSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Error
- if there is a generic error.
InvalidArgument
- if the cluster id is empty.
NotFound
- if the cluster is not found.
Unauthenticated
- if the caller is not authenticated.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.spec
- The search specification.
if return all information.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String delete_Task(java.lang.String cluster, java.lang.String version)
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.version
- The ESX base image version.
The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage
.Error
- if there is a generic error.InvalidArgument
- if the version is invalid or the cluster id is empty.NotFound
- if the version or cluster is not found.Unauthenticated
- if the caller is not authenticated.java.lang.String delete_Task(java.lang.String cluster, java.lang.String version, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
Use invocationConfig
to specify configuration for this particular invocation.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.version
- The ESX base image version.
The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage
.invocationConfig
- Configuration for the method invocation.Error
- if there is a generic error.InvalidArgument
- if the version is invalid or the cluster id is empty.NotFound
- if the version or cluster is not found.Unauthenticated
- if the caller is not authenticated.void delete_Task(java.lang.String cluster, java.lang.String version, AsyncCallback<java.lang.String> asyncCallback)
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Error
- if there is a generic error.
InvalidArgument
- if the version is invalid or the cluster id is empty.
NotFound
- if the version or cluster is not found.
Unauthenticated
- if the caller is not authenticated.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.version
- The ESX base image version.
The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void delete_Task(java.lang.String cluster, java.lang.String version, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Error
- if there is a generic error.
InvalidArgument
- if the version is invalid or the cluster id is empty.
NotFound
- if the version or cluster is not found.
Unauthenticated
- if the caller is not authenticated.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.version
- The ESX base image version.
The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String get_Task(java.lang.String cluster, java.lang.String version)
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.version
- The ESX base image version.
The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage
.Error
- if there is a generic error.InvalidArgument
- if the version is invalid or the cluster id is empty.NotFound
- if the version or cluster is not found.Unauthenticated
- if the caller is not authenticated.java.lang.String get_Task(java.lang.String cluster, java.lang.String version, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
Use invocationConfig
to specify configuration for this particular invocation.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.version
- The ESX base image version.
The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage
.invocationConfig
- Configuration for the method invocation.Error
- if there is a generic error.InvalidArgument
- if the version is invalid or the cluster id is empty.NotFound
- if the version or cluster is not found.Unauthenticated
- if the caller is not authenticated.void get_Task(java.lang.String cluster, java.lang.String version, AsyncCallback<java.lang.String> asyncCallback)
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Error
- if there is a generic error.
InvalidArgument
- if the version is invalid or the cluster id is empty.
NotFound
- if the version or cluster is not found.
Unauthenticated
- if the caller is not authenticated.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.version
- The ESX base image version.
The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void get_Task(java.lang.String cluster, java.lang.String version, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Error
- if there is a generic error.
InvalidArgument
- if the version is invalid or the cluster id is empty.
NotFound
- if the version or cluster is not found.
Unauthenticated
- if the caller is not authenticated.
cluster
- The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type: ClusterComputeResource
.version
- The ESX base image version.
The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.