com.vmware.esx.settings.hosts

Interface DepotOverrides

All Superinterfaces:

DepotOverridesTypes, Service

All Known Implementing Classes:

DepotOverridesStub

public interface DepotOverrides
extends Service, DepotOverridesTypes

The DepotOverrides interface provides methods to manage software depots overriden for a given host. In general ESX servers reach out to vCenter (VUM) to fetch the metadata and payloads required for lifecycle operations. But in ROBO environments ESX hosts can't (or because of bandwidth requirements shouldn't) reach out to vCenter to fetch payloads and metadata. This interface allows setting host level overrides for depots. If any depots are provided for a host, then vCenter level depots are not used for that host's remediation. These are not synced periodically at vCenter and are only used by ESXs for lifecycle operations. This interface was added in vSphere API 8.0.1.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.hosts.DepotOverridesTypes

DepotOverridesTypes.Depot, DepotOverridesTypes.Info

Field Summary

Fields inherited from interface com.vmware.esx.settings.hosts.DepotOverridesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String host, DepotOverridesTypes.Depot depot) Adds a new depot override to the list of currently configured depot overrides for a given host.
void	add(java.lang.String host, DepotOverridesTypes.Depot depot, AsyncCallback<java.lang.Void> asyncCallback) Adds a new depot override to the list of currently configured depot overrides for a given host.
void	add(java.lang.String host, DepotOverridesTypes.Depot depot, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Adds a new depot override to the list of currently configured depot overrides for a given host.
void	add(java.lang.String host, DepotOverridesTypes.Depot depot, InvocationConfig invocationConfig) Adds a new depot override to the list of currently configured depot overrides for a given host.
DepotOverridesTypes.Info	get(java.lang.String host) Returns the information about currently configured depot overrides for a given host.
void	get(java.lang.String host, AsyncCallback<DepotOverridesTypes.Info> asyncCallback) Returns the information about currently configured depot overrides for a given host.
void	get(java.lang.String host, AsyncCallback<DepotOverridesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the information about currently configured depot overrides for a given host.
DepotOverridesTypes.Info	get(java.lang.String host, InvocationConfig invocationConfig) Returns the information about currently configured depot overrides for a given host.
void	remove(java.lang.String host, DepotOverridesTypes.Depot depot) Removes a depot override from the list of currently configured depot overrides for a given host.
void	remove(java.lang.String host, DepotOverridesTypes.Depot depot, AsyncCallback<java.lang.Void> asyncCallback) Removes a depot override from the list of currently configured depot overrides for a given host.
void	remove(java.lang.String host, DepotOverridesTypes.Depot depot, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Removes a depot override from the list of currently configured depot overrides for a given host.
void	remove(java.lang.String host, DepotOverridesTypes.Depot depot, InvocationConfig invocationConfig) Removes a depot override from the list of currently configured depot overrides for a given host.

Method Detail

get

DepotOverridesTypes.Info get(java.lang.String host)

Returns the information about currently configured depot overrides for a given host. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

host - Identifier for the host. The parameter must be an identifier for the resource type: HostSystem.

Returns:

Information about currently configured depot overrides for a given host.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no host associated with host in the system.

ServiceUnavailable - If the service is not available.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

Unsupported - If the host is not a vLCM managed standlone host.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.

get

DepotOverridesTypes.Info get(java.lang.String host,
                             InvocationConfig invocationConfig)

Returns the information about currently configured depot overrides for a given host. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

host - Identifier for the host. The parameter must be an identifier for the resource type: HostSystem.

invocationConfig - Configuration for the method invocation.

Returns:

Information about currently configured depot overrides for a given host.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no host associated with host in the system.

ServiceUnavailable - If the service is not available.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

Unsupported - If the host is not a vLCM managed standlone host.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.

get

void get(java.lang.String host,
         AsyncCallback<DepotOverridesTypes.Info> asyncCallback)

Returns the information about currently configured depot overrides for a given host. This method was added in vSphere API 8.0.1.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Information about currently configured depot overrides for a given host.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no host associated with host in the system.
ServiceUnavailable - If the service is not available.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unsupported - If the host is not a vLCM managed standlone host.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.

Parameters:

host - Identifier for 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.

get

void get(java.lang.String host,
         AsyncCallback<DepotOverridesTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns the information about currently configured depot overrides for a given host. This method was added in vSphere API 8.0.1.0.

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 currently configured depot overrides for a given host.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no host associated with host in the system.
ServiceUnavailable - If the service is not available.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unsupported - If the host is not a vLCM managed standlone host.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.

Parameters:

host - Identifier for 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.

add

void add(java.lang.String host,
         DepotOverridesTypes.Depot depot)

Adds a new depot override to the list of currently configured depot overrides for a given host. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

host - Identifier for the host. The parameter must be an identifier for the resource type: HostSystem.

depot - Information of a depot override.

Throws:

Unauthenticated - if the caller is not authenticated.

InvalidArgument - If an invalid location is provided.

NotFound - If there is no host associated with host in the system.

AlreadyExists - if depot override with given information already exists.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unsupported - If the host is not a vLCM managed standlone host.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.

add

void add(java.lang.String host,
         DepotOverridesTypes.Depot depot,
         InvocationConfig invocationConfig)

Adds a new depot override to the list of currently configured depot overrides for a given host. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

host - Identifier for the host. The parameter must be an identifier for the resource type: HostSystem.

depot - Information of a depot override.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

InvalidArgument - If an invalid location is provided.

NotFound - If there is no host associated with host in the system.

AlreadyExists - if depot override with given information already exists.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unsupported - If the host is not a vLCM managed standlone host.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.

add

void add(java.lang.String host,
         DepotOverridesTypes.Depot depot,
         AsyncCallback<java.lang.Void> asyncCallback)

Adds a new depot override to the list of currently configured depot overrides for a given host. This method was added in vSphere API 8.0.1.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
InvalidArgument - If an invalid location is provided.
NotFound - If there is no host associated with host in the system.
AlreadyExists - if depot override with given information already exists.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unsupported - If the host is not a vLCM managed standlone host.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.

Parameters:

host - Identifier for the host. The parameter must be an identifier for the resource type: HostSystem.

depot - Information of a depot override.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

add

void add(java.lang.String host,
         DepotOverridesTypes.Depot depot,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Adds a new depot override to the list of currently configured depot overrides for a given host. This method was added in vSphere API 8.0.1.0.

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:
Unauthenticated - if the caller is not authenticated.
InvalidArgument - If an invalid location is provided.
NotFound - If there is no host associated with host in the system.
AlreadyExists - if depot override with given information already exists.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unsupported - If the host is not a vLCM managed standlone host.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.

Parameters:

host - Identifier for the host. The parameter must be an identifier for the resource type: HostSystem.

depot - Information of a depot override.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

remove

void remove(java.lang.String host,
            DepotOverridesTypes.Depot depot)

Removes a depot override from the list of currently configured depot overrides for a given host. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

host - Identifier for the host. The parameter must be an identifier for the resource type: HostSystem.

depot - Information of the depot override to be removed.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no depot override with given information or no host associated with identifier {param.name host} in the system.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unsupported - If the host is not a vLCM managed standlone host.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.

remove

void remove(java.lang.String host,
            DepotOverridesTypes.Depot depot,
            InvocationConfig invocationConfig)

Removes a depot override from the list of currently configured depot overrides for a given host. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

host - Identifier for the host. The parameter must be an identifier for the resource type: HostSystem.

depot - Information of the depot override to be removed.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no depot override with given information or no host associated with identifier {param.name host} in the system.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unsupported - If the host is not a vLCM managed standlone host.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.

remove

void remove(java.lang.String host,
            DepotOverridesTypes.Depot depot,
            AsyncCallback<java.lang.Void> asyncCallback)

Removes a depot override from the list of currently configured depot overrides for a given host. This method was added in vSphere API 8.0.1.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no depot override with given information or no host associated with identifier {param.name host} in the system.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unsupported - If the host is not a vLCM managed standlone host.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.

Parameters:

host - Identifier for the host. The parameter must be an identifier for the resource type: HostSystem.

depot - Information of the depot override to be removed.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

remove

void remove(java.lang.String host,
            DepotOverridesTypes.Depot depot,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Removes a depot override from the list of currently configured depot overrides for a given host. This method was added in vSphere API 8.0.1.0.

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:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no depot override with given information or no host associated with identifier {param.name host} in the system.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unsupported - If the host is not a vLCM managed standlone host.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Write.

Parameters:

host - Identifier for the host. The parameter must be an identifier for the resource type: HostSystem.

depot - Information of the depot override to be removed.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.