vmware::esx::settings::depots::Offline Interface Reference

The Offline interface provides methods to manage Offline Software Depots used during ESX lifecycle management. More...

Inherited by vmware::esx::settings::depots::OfflineStub.

List of all members.

Public Member Functions
vmware.esx.settings.depots.OfflineTypes.Info	Get (string depot)
	Gets the information about an imported offline software depot.
vmware.esx.settings.depots.OfflineTypes.Info	Get (string depot, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Gets the information about an imported offline software depot.
global::System.Threading.Tasks.Task < vmware.esx.settings.depots.OfflineTypes.Info >	GetAsync (string depot)
	Gets the information about an imported offline software depot.
global::System.Threading.Tasks.Task < vmware.esx.settings.depots.OfflineTypes.Info >	GetAsync (string depot, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Gets the information about an imported offline software depot.
global::System.Collections.Generic.Dictionary < string, vmware.esx.settings.depots.OfflineTypes.Summary >	List ()
	Returns currently imported offline software depots.
global::System.Collections.Generic.Dictionary < string, vmware.esx.settings.depots.OfflineTypes.Summary >	List (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns currently imported offline software depots.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < string, vmware.esx.settings.depots.OfflineTypes.Summary > >	ListAsync ()
	Returns currently imported offline software depots.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < string, vmware.esx.settings.depots.OfflineTypes.Summary > >	ListAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns currently imported offline software depots.
string	Create_Task (vmware.esx.settings.depots.OfflineTypes.CreateSpec spec)
	Imports a new offline software depot.
string	Create_Task (vmware.esx.settings.depots.OfflineTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Imports a new offline software depot.
void	Delete (string depot)
	Removes a depot from the list of imported offline software depots.
void	Delete (string depot, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Removes a depot from the list of imported offline software depots.
global::System.Threading.Tasks.Task	DeleteAsync (string depot)
	Removes a depot from the list of imported offline software depots.
global::System.Threading.Tasks.Task	DeleteAsync (string depot, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Removes a depot from the list of imported offline software depots.

---

Detailed Description

The Offline interface provides methods to manage Offline Software Depots used during ESX lifecycle management.

---

Member Function Documentation

string vmware::esx::settings::depots::Offline::Create_Task

(

vmware.esx.settings.depots.OfflineTypes.CreateSpec

spec

)

Imports a new offline software depot.

This will also import the metadata and payloads from this offline depot. The returned task will fail and no Offline Depot would be created if there are any issues during import. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.InvalidArgument	If an invalid pullLocation is provided.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.AlreadyExists	If the depot content of {@param.name CreateSpec} already exists. The value of the data field of vmware.vapi.std.errors.Error will be a class that contains existing depot content id as part of depot field defined in Offline.CreateResult .
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.

Parameters:

spec	Depot specification to import an offline depot.

Returns:

Identifier for the task created by this API invocation

Implemented in vmware::esx::settings::depots::OfflineStub.

string vmware::esx::settings::depots::Offline::Create_Task	(	vmware.esx.settings.depots.OfflineTypes.CreateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Imports a new offline software depot.

This will also import the metadata and payloads from this offline depot. The returned task will fail and no Offline Depot would be created if there are any issues during import. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.InvalidArgument	If an invalid pullLocation is provided.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.AlreadyExists	If the depot content of {@param.name CreateSpec} already exists. The value of the data field of vmware.vapi.std.errors.Error will be a class that contains existing depot content id as part of depot field defined in Offline.CreateResult .
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.

Parameters:

spec	Depot specification to import an offline depot.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Identifier for the task created by this API invocation

Implemented in vmware::esx::settings::depots::OfflineStub.

void vmware::esx::settings::depots::Offline::Delete

(

string

depot

)

Removes a depot from the list of imported offline software depots.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no depot associated with parameter depot in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Write .

Parameters:

depot

Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline .

Implemented in vmware::esx::settings::depots::OfflineStub.

void vmware::esx::settings::depots::Offline::Delete	(	string	depot,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Removes a depot from the list of imported offline software depots.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no depot associated with parameter depot in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Write .

Parameters:

depot	Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::esx::settings::depots::OfflineStub.

global::System.Threading.Tasks.Task vmware::esx::settings::depots::Offline::DeleteAsync

(

string

depot

)

Removes a depot from the list of imported offline software depots.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no depot associated with parameter depot in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Write .

Parameters:

depot

Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline .

Implemented in vmware::esx::settings::depots::OfflineStub.

global::System.Threading.Tasks.Task vmware::esx::settings::depots::Offline::DeleteAsync	(	string	depot,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Removes a depot from the list of imported offline software depots.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no depot associated with parameter depot in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Write .

Parameters:

depot	Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::esx::settings::depots::OfflineStub.

vmware.esx.settings.depots.OfflineTypes.Info vmware::esx::settings::depots::Offline::Get	(	string	depot,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Gets the information about an imported offline software depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no depot with given identifier depot in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Read .

Parameters:

depot	Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Information about the imported offline software depot.

Implemented in vmware::esx::settings::depots::OfflineStub.

vmware.esx.settings.depots.OfflineTypes.Info vmware::esx::settings::depots::Offline::Get

(

string

depot

)

Gets the information about an imported offline software depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no depot with given identifier depot in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Read .

Parameters:

depot

Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline .

Returns:

Information about the imported offline software depot.

Implemented in vmware::esx::settings::depots::OfflineStub.

global::System.Threading.Tasks.Task<vmware.esx.settings.depots.OfflineTypes.Info> vmware::esx::settings::depots::Offline::GetAsync

(

string

depot

)

Gets the information about an imported offline software depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no depot with given identifier depot in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Read .

Parameters:

depot

Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline .

Returns:

Information about the imported offline software depot.

Implemented in vmware::esx::settings::depots::OfflineStub.

global::System.Threading.Tasks.Task<vmware.esx.settings.depots.OfflineTypes.Info> vmware::esx::settings::depots::Offline::GetAsync	(	string	depot,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Gets the information about an imported offline software depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no depot with given identifier depot in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Read .

Parameters:

depot	Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Information about the imported offline software depot.

Implemented in vmware::esx::settings::depots::OfflineStub.

global::System.Collections.Generic.Dictionary<string, vmware.esx.settings.depots.OfflineTypes.Summary> vmware::esx::settings::depots::Offline::List	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns currently imported offline software depots.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Read .

Returns:

Map of currently imported offline software depots keyed by their identifier. The key in the result map will be an identifier for the resource type: com.vmware.esx.settings.depots.offline .

Implemented in vmware::esx::settings::depots::OfflineStub.

global::System.Collections.Generic.Dictionary<string, vmware.esx.settings.depots.OfflineTypes.Summary> vmware::esx::settings::depots::Offline::List

(

)

Returns currently imported offline software depots.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Read .

Returns:

Map of currently imported offline software depots keyed by their identifier. The key in the result map will be an identifier for the resource type: com.vmware.esx.settings.depots.offline .

Implemented in vmware::esx::settings::depots::OfflineStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<string, vmware.esx.settings.depots.OfflineTypes.Summary> > vmware::esx::settings::depots::Offline::ListAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns currently imported offline software depots.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Read .

Returns:

Map of currently imported offline software depots keyed by their identifier. The key in the result map will be an identifier for the resource type: com.vmware.esx.settings.depots.offline .

Implemented in vmware::esx::settings::depots::OfflineStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<string, vmware.esx.settings.depots.OfflineTypes.Summary> > vmware::esx::settings::depots::Offline::ListAsync

(

)

Returns currently imported offline software depots.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Read .

Returns:

Map of currently imported offline software depots keyed by their identifier. The key in the result map will be an identifier for the resource type: com.vmware.esx.settings.depots.offline .

Implemented in vmware::esx::settings::depots::OfflineStub.

---

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

• Offline.cs