public interface Drafts extends Service, DraftsTypes
Drafts
interface provides methods to manage working copy of software
documents. This interface was added in vSphere API 8.0.0.1.DraftsTypes._VAPI_OPERATIONS, DraftsTypes.CommitSpec, DraftsTypes.FilterSpec, DraftsTypes.ImportSpec, DraftsTypes.Info, DraftsTypes.Metadata, DraftsTypes.SourceType, DraftsTypes.StatusType, DraftsTypes.Summary, DraftsTypes.ValidateResult
_VAPI_SERVICE_ID, RESOURCE_TYPE
Modifier and Type | Method and Description |
---|---|
java.lang.String |
commit_Task(java.lang.String host,
java.lang.String draft,
DraftsTypes.CommitSpec spec)
Commits the specified draft as the desired state document.
|
void |
commit_Task(java.lang.String host,
java.lang.String draft,
DraftsTypes.CommitSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Commits the specified draft as the desired state document.
|
void |
commit_Task(java.lang.String host,
java.lang.String draft,
DraftsTypes.CommitSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Commits the specified draft as the desired state document.
|
java.lang.String |
commit_Task(java.lang.String host,
java.lang.String draft,
DraftsTypes.CommitSpec spec,
InvocationConfig invocationConfig)
Commits the specified draft as the desired state document.
|
java.lang.String |
create(java.lang.String host)
Creates a new software draft from the desired document.
|
void |
create(java.lang.String host,
AsyncCallback<java.lang.String> asyncCallback)
Creates a new software draft from the desired document.
|
void |
create(java.lang.String host,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Creates a new software draft from the desired document.
|
java.lang.String |
create(java.lang.String host,
InvocationConfig invocationConfig)
Creates a new software draft from the desired document.
|
void |
delete(java.lang.String host,
java.lang.String draft)
Deletes the software draft.
|
void |
delete(java.lang.String host,
java.lang.String draft,
AsyncCallback<java.lang.Void> asyncCallback)
Deletes the software draft.
|
void |
delete(java.lang.String host,
java.lang.String draft,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Deletes the software draft.
|
void |
delete(java.lang.String host,
java.lang.String draft,
InvocationConfig invocationConfig)
Deletes the software draft.
|
DraftsTypes.Info |
get(java.lang.String host,
java.lang.String draft)
Returns the information about given software draft.
|
void |
get(java.lang.String host,
java.lang.String draft,
AsyncCallback<DraftsTypes.Info> asyncCallback)
Returns the information about given software draft.
|
void |
get(java.lang.String host,
java.lang.String draft,
AsyncCallback<DraftsTypes.Info> asyncCallback,
InvocationConfig invocationConfig)
Returns the information about given software draft.
|
DraftsTypes.Info |
get(java.lang.String host,
java.lang.String draft,
InvocationConfig invocationConfig)
Returns the information about given software draft.
|
java.lang.String |
importSoftwareSpec(java.lang.String host,
DraftsTypes.ImportSpec spec)
Imports the desired software specification.
|
void |
importSoftwareSpec(java.lang.String host,
DraftsTypes.ImportSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Imports the desired software specification.
|
void |
importSoftwareSpec(java.lang.String host,
DraftsTypes.ImportSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Imports the desired software specification.
|
java.lang.String |
importSoftwareSpec(java.lang.String host,
DraftsTypes.ImportSpec spec,
InvocationConfig invocationConfig)
Imports the desired software specification.
|
java.util.Map<java.lang.String,DraftsTypes.Summary> |
list(java.lang.String host,
DraftsTypes.FilterSpec filter)
Returns information about the software drafts for the specified host that match
the
DraftsTypes.FilterSpec . |
void |
list(java.lang.String host,
DraftsTypes.FilterSpec filter,
AsyncCallback<java.util.Map<java.lang.String,DraftsTypes.Summary>> asyncCallback)
Returns information about the software drafts for the specified host that match
the
DraftsTypes.FilterSpec . |
void |
list(java.lang.String host,
DraftsTypes.FilterSpec filter,
AsyncCallback<java.util.Map<java.lang.String,DraftsTypes.Summary>> asyncCallback,
InvocationConfig invocationConfig)
Returns information about the software drafts for the specified host that match
the
DraftsTypes.FilterSpec . |
java.util.Map<java.lang.String,DraftsTypes.Summary> |
list(java.lang.String host,
DraftsTypes.FilterSpec filter,
InvocationConfig invocationConfig)
Returns information about the software drafts for the specified host that match
the
DraftsTypes.FilterSpec . |
java.lang.String |
scan_Task(java.lang.String host,
java.lang.String draft)
Scans the host against the software draft.
|
void |
scan_Task(java.lang.String host,
java.lang.String draft,
AsyncCallback<java.lang.String> asyncCallback)
Scans the host against the software draft.
|
void |
scan_Task(java.lang.String host,
java.lang.String draft,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Scans the host against the software draft.
|
java.lang.String |
scan_Task(java.lang.String host,
java.lang.String draft,
InvocationConfig invocationConfig)
Scans the host against the software draft.
|
java.lang.String |
validate_Task(java.lang.String host,
java.lang.String draft)
Validates the software draft.
|
void |
validate_Task(java.lang.String host,
java.lang.String draft,
AsyncCallback<java.lang.String> asyncCallback)
Validates the software draft.
|
void |
validate_Task(java.lang.String host,
java.lang.String draft,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Validates the software draft.
|
java.lang.String |
validate_Task(java.lang.String host,
java.lang.String draft,
InvocationConfig invocationConfig)
Validates the software draft.
|
java.lang.String commit_Task(java.lang.String host, java.lang.String draft, DraftsTypes.CommitSpec spec)
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the draft.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.spec
- The spec to be used to create the commit.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotAllowedInCurrentState
- If there is another operation in progress.NotFound
- If there is no host associated with host
or if there is no draft
associated with draft
in the system.InvalidArgument
- If validation of the software document fails. The value of the data property of
Error
will be a class that contains all the
properties defined in DraftsTypes.ValidateResult
.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.java.lang.String commit_Task(java.lang.String host, java.lang.String draft, DraftsTypes.CommitSpec 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.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the draft.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.spec
- The spec to be used to create the commit.invocationConfig
- Configuration for the method invocation.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotAllowedInCurrentState
- If there is another operation in progress.NotFound
- If there is no host associated with host
or if there is no draft
associated with draft
in the system.InvalidArgument
- If validation of the software document fails. The value of the data property of
Error
will be a class that contains all the
properties defined in DraftsTypes.ValidateResult
.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.void commit_Task(java.lang.String host, java.lang.String draft, DraftsTypes.CommitSpec 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 unknown internal error. The accompanying error message will give
more details about the failure.
NotAllowedInCurrentState
- If there is another operation in progress.
NotFound
- If there is no host associated with host
or if there is no draft
associated with draft
in the system.
InvalidArgument
- If validation of the software document fails. The value of the data property of
Error
will be a class that contains all the
properties defined in DraftsTypes.ValidateResult
.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the draft.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.spec
- The spec to be used to create the commit.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void commit_Task(java.lang.String host, java.lang.String draft, DraftsTypes.CommitSpec 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 unknown internal error. The accompanying error message will give
more details about the failure.
NotAllowedInCurrentState
- If there is another operation in progress.
NotFound
- If there is no host associated with host
or if there is no draft
associated with draft
in the system.
InvalidArgument
- If validation of the software document fails. The value of the data property of
Error
will be a class that contains all the
properties defined in DraftsTypes.ValidateResult
.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the draft.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.spec
- The spec to be used to create the commit.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 host)
Synchronous method overload. Result of the invocation will be reported as a method return value.
host
- Identifier of the host
The parameter must be an identifier for the resource type: HostSystem
.com.vmware.esx.settings.draft
.AlreadyExists
- If there is already a draft created by this user.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Write
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Write
.
java.lang.String create(java.lang.String host, 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.
host
- Identifier of the host
The parameter must be an identifier for the resource type: HostSystem
.invocationConfig
- Configuration for the method invocation.com.vmware.esx.settings.draft
.AlreadyExists
- If there is already a draft created by this user.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Write
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Write
.
void create(java.lang.String host, AsyncCallback<java.lang.String> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Identifier of the working copy of the document.
The return value will be an identifier for the resource type: com.vmware.esx.settings.draft
.
Operation Errors:
AlreadyExists
- If there is already a draft created by this user.
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Write
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Write
.
host
- Identifier of the host
The parameter must be an identifier for the resource type: HostSystem
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void create(java.lang.String host, 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:
Identifier of the working copy of the document.
The return value will be an identifier for the resource type: com.vmware.esx.settings.draft
.
Operation Errors:
AlreadyExists
- If there is already a draft created by this user.
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Write
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Write
.
host
- Identifier of the host
The parameter must be an identifier for the resource type: HostSystem
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void delete(java.lang.String host, java.lang.String draft)
Synchronous method overload. Result of the invocation will be reported as a method return value.
host
- Identifier of the host
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the draft.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Write
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Write
.
void delete(java.lang.String host, java.lang.String draft, 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.
host
- Identifier of the host
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the draft.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.invocationConfig
- Configuration for the method invocation.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Write
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Write
.
void delete(java.lang.String host, java.lang.String draft, AsyncCallback<java.lang.Void> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Write
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Write
.
host
- Identifier of the host
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the draft.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void delete(java.lang.String host, java.lang.String draft, 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 there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Write
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Write
.
host
- Identifier of the host
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the draft.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.DraftsTypes.Info get(java.lang.String host, java.lang.String draft)
Synchronous method overload. Result of the invocation will be reported as a method return value.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the working copy of the document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
DraftsTypes.Info get(java.lang.String host, java.lang.String draft, 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.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the working copy of the document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.invocationConfig
- Configuration for the method invocation.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
void get(java.lang.String host, java.lang.String draft, AsyncCallback<DraftsTypes.Info> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Information about the Software Draft.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the working copy of the document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void get(java.lang.String host, java.lang.String draft, AsyncCallback<DraftsTypes.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 Software Draft.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the working copy of the document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.util.Map<java.lang.String,DraftsTypes.Summary> list(java.lang.String host, DraftsTypes.FilterSpec filter)
DraftsTypes.FilterSpec
. This
method was added in vSphere API 8.0.0.1.
Synchronous method overload. Result of the invocation will be reported as a method return value.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.filter
- Filter to be applied while returning drafts.
If null
, all drafts will be returned.Map
will be an identifier for the
resource type: com.vmware.esx.settings.draft
.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
java.util.Map<java.lang.String,DraftsTypes.Summary> list(java.lang.String host, DraftsTypes.FilterSpec filter, InvocationConfig invocationConfig)
DraftsTypes.FilterSpec
. This
method was added in vSphere API 8.0.0.1.
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.filter
- Filter to be applied while returning drafts.
If null
, all drafts will be returned.invocationConfig
- Configuration for the method invocation.Map
will be an identifier for the
resource type: com.vmware.esx.settings.draft
.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
void list(java.lang.String host, DraftsTypes.FilterSpec filter, AsyncCallback<java.util.Map<java.lang.String,DraftsTypes.Summary>> asyncCallback)
DraftsTypes.FilterSpec
. This
method was added in vSphere API 8.0.0.1.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Map of software drafts keyed by their identifiers.
The key in the return value Map
will be an identifier for the
resource type: com.vmware.esx.settings.draft
.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.filter
- Filter to be applied while returning drafts.
If null
, all drafts will be returned.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void list(java.lang.String host, DraftsTypes.FilterSpec filter, AsyncCallback<java.util.Map<java.lang.String,DraftsTypes.Summary>> asyncCallback, InvocationConfig invocationConfig)
DraftsTypes.FilterSpec
. This
method was added in vSphere API 8.0.0.1.
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:
Map of software drafts keyed by their identifiers.
The key in the return value Map
will be an identifier for the
resource type: com.vmware.esx.settings.draft
.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.filter
- Filter to be applied while returning drafts.
If null
, all drafts will be returned.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String validate_Task(java.lang.String host, java.lang.String draft)
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the working copy of the document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.java.lang.String validate_Task(java.lang.String host, java.lang.String draft, 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.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the working copy of the document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.invocationConfig
- Configuration for the method invocation.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.void validate_Task(java.lang.String host, java.lang.String draft, 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 unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the working copy of the document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void validate_Task(java.lang.String host, java.lang.String draft, 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 unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the working copy of the document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String scan_Task(java.lang.String host, java.lang.String draft)
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the working copy of the document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.java.lang.String scan_Task(java.lang.String host, java.lang.String draft, 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.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the working copy of the document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.invocationConfig
- Configuration for the method invocation.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.void scan_Task(java.lang.String host, java.lang.String draft, 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 unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the working copy of the document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void scan_Task(java.lang.String host, java.lang.String draft, 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 unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
or no draft associated with
draft
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.draft
- Identifier of the working copy of the document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String importSoftwareSpec(java.lang.String host, DraftsTypes.ImportSpec spec)
Synchronous method overload. Result of the invocation will be reported as a method return value.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- Specification to import desired software specification.com.vmware.esx.settings.draft
.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
in the system or if the source
type of import specification is of either LATEST_RECOMMENDATION
or
CURRENT_SERIES_RECOMMENDATION
, and a recommendation does not exist for
the host. It was either never generated or deleted due to changes in host state
such as a new desired image spec being committed.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Write
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Write
.
java.lang.String importSoftwareSpec(java.lang.String host, DraftsTypes.ImportSpec 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.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- Specification to import desired software specification.invocationConfig
- Configuration for the method invocation.com.vmware.esx.settings.draft
.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
in the system or if the source
type of import specification is of either LATEST_RECOMMENDATION
or
CURRENT_SERIES_RECOMMENDATION
, and a recommendation does not exist for
the host. It was either never generated or deleted due to changes in host state
such as a new desired image spec being committed.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Write
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Write
.
void importSoftwareSpec(java.lang.String host, DraftsTypes.ImportSpec spec, AsyncCallback<java.lang.String> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Identifier of the working copy of the document.
The return value will be an identifier for the resource type: com.vmware.esx.settings.draft
.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
in the system or if the source
type of import specification is of either LATEST_RECOMMENDATION
or
CURRENT_SERIES_RECOMMENDATION
, and a recommendation does not exist for
the host. It was either never generated or deleted due to changes in host state
such as a new desired image spec being committed.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Write
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Write
.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- Specification to import desired software specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void importSoftwareSpec(java.lang.String host, DraftsTypes.ImportSpec 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:
Identifier of the working copy of the document.
The return value will be an identifier for the resource type: com.vmware.esx.settings.draft
.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
in the system or if the source
type of import specification is of either LATEST_RECOMMENDATION
or
CURRENT_SERIES_RECOMMENDATION
, and a recommendation does not exist for
the host. It was either never generated or deleted due to changes in host state
such as a new desired image spec being committed.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Write
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Write
.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- Specification to import desired software specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.