VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::content::LocalLibrary Interface Reference

The LocalLibrary interface manages local libraries. More...

Inherited by vmware::content::LocalLibraryStub.

List of all members.

Public Member Functions

string Create (string clientToken, vmware.content.LibraryModel createSpec)
 Creates a new local library.
string Create (string clientToken, vmware.content.LibraryModel createSpec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Creates a new local library.
global::System.Threading.Tasks.Task
< string > 
CreateAsync (string clientToken, vmware.content.LibraryModel createSpec)
 Creates a new local library.
global::System.Threading.Tasks.Task
< string > 
CreateAsync (string clientToken, vmware.content.LibraryModel createSpec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Creates a new local library.
void Delete (string libraryId)
 Deletes the specified local library.
void Delete (string libraryId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Deletes the specified local library.
global::System.Threading.Tasks.Task DeleteAsync (string libraryId)
 Deletes the specified local library.
global::System.Threading.Tasks.Task DeleteAsync (string libraryId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Deletes the specified local library.
vmware.content.LibraryModel Get (string libraryId)
 Returns a given local library.
vmware.content.LibraryModel Get (string libraryId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns a given local library.
global::System.Threading.Tasks.Task
< vmware.content.LibraryModel
GetAsync (string libraryId)
 Returns a given local library.
global::System.Threading.Tasks.Task
< vmware.content.LibraryModel
GetAsync (string libraryId, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns a given local library.
global::System.Collections.Generic.List
< string > 
List ()
 Returns the identifiers of all local libraries in the Content Library.
global::System.Collections.Generic.List
< string > 
List (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns the identifiers of all local libraries in the Content Library.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< string > > 
ListAsync ()
 Returns the identifiers of all local libraries in the Content Library.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< string > > 
ListAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns the identifiers of all local libraries in the Content Library.
void Update (string libraryId, vmware.content.LibraryModel updateSpec)
 Updates the properties of a local library.
void Update (string libraryId, vmware.content.LibraryModel updateSpec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Updates the properties of a local library.
global::System.Threading.Tasks.Task UpdateAsync (string libraryId, vmware.content.LibraryModel updateSpec)
 Updates the properties of a local library.
global::System.Threading.Tasks.Task UpdateAsync (string libraryId, vmware.content.LibraryModel updateSpec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Updates the properties of a local library.
void Publish (string libraryId, global::System.Collections.Generic.List< vmware.content.LocalLibraryTypes.DestinationSpec > subscriptions)
 Publishes the library to specified subscriptions.
void Publish (string libraryId, global::System.Collections.Generic.List< vmware.content.LocalLibraryTypes.DestinationSpec > subscriptions, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Publishes the library to specified subscriptions.
global::System.Threading.Tasks.Task PublishAsync (string libraryId, global::System.Collections.Generic.List< vmware.content.LocalLibraryTypes.DestinationSpec > subscriptions)
 Publishes the library to specified subscriptions.
global::System.Threading.Tasks.Task PublishAsync (string libraryId, global::System.Collections.Generic.List< vmware.content.LocalLibraryTypes.DestinationSpec > subscriptions, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Publishes the library to specified subscriptions.

Detailed Description

The LocalLibrary interface manages local libraries.

The LocalLibrary interface provides support for creating and maintaining local library instances. A local library may also use the Library interface to manage general library functionality.


Member Function Documentation

string vmware::content::LocalLibrary::Create ( string  clientToken,
vmware.content.LibraryModel  createSpec 
)

Creates a new local library.

Exceptions:
vmware.vapi.std.errors.InvalidArgumentif the createSpec is not valid.
vmware.vapi.std.errors.InvalidArgumentif the clientToken does not conform to the UUID format.
vmware.vapi.std.errors.Unsupportedif using multiple storage backings.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires ContentLibrary.CreateLocalLibrary .
  • The resource Datastore referenced by the attribute library.StorageBacking.datastoreId requires Datastore.AllocateSpace .
Parameters:
clientTokenA unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751 . This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.
createSpecSpecification for the new local library.
Returns:
Identifier of the newly created LibraryModel . The result will be an identifier for the resource type: com.vmware.content.Library .

Implemented in vmware::content::LocalLibraryStub.

string vmware::content::LocalLibrary::Create ( string  clientToken,
vmware.content.LibraryModel  createSpec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Creates a new local library.

Exceptions:
vmware.vapi.std.errors.InvalidArgumentif the createSpec is not valid.
vmware.vapi.std.errors.InvalidArgumentif the clientToken does not conform to the UUID format.
vmware.vapi.std.errors.Unsupportedif using multiple storage backings.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires ContentLibrary.CreateLocalLibrary .
  • The resource Datastore referenced by the attribute library.StorageBacking.datastoreId requires Datastore.AllocateSpace .
Parameters:
clientTokenA unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751 . This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.
createSpecSpecification for the new local library.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Identifier of the newly created LibraryModel . The result will be an identifier for the resource type: com.vmware.content.Library .

Implemented in vmware::content::LocalLibraryStub.

global::System.Threading.Tasks.Task<string> vmware::content::LocalLibrary::CreateAsync ( string  clientToken,
vmware.content.LibraryModel  createSpec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Creates a new local library.

Exceptions:
vmware.vapi.std.errors.InvalidArgumentif the createSpec is not valid.
vmware.vapi.std.errors.InvalidArgumentif the clientToken does not conform to the UUID format.
vmware.vapi.std.errors.Unsupportedif using multiple storage backings.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires ContentLibrary.CreateLocalLibrary .
  • The resource Datastore referenced by the attribute library.StorageBacking.datastoreId requires Datastore.AllocateSpace .
Parameters:
clientTokenA unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751 . This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.
createSpecSpecification for the new local library.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Identifier of the newly created LibraryModel . The result will be an identifier for the resource type: com.vmware.content.Library .

Implemented in vmware::content::LocalLibraryStub.

global::System.Threading.Tasks.Task<string> vmware::content::LocalLibrary::CreateAsync ( string  clientToken,
vmware.content.LibraryModel  createSpec 
)

Creates a new local library.

Exceptions:
vmware.vapi.std.errors.InvalidArgumentif the createSpec is not valid.
vmware.vapi.std.errors.InvalidArgumentif the clientToken does not conform to the UUID format.
vmware.vapi.std.errors.Unsupportedif using multiple storage backings.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires ContentLibrary.CreateLocalLibrary .
  • The resource Datastore referenced by the attribute library.StorageBacking.datastoreId requires Datastore.AllocateSpace .
Parameters:
clientTokenA unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751 . This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.
createSpecSpecification for the new local library.
Returns:
Identifier of the newly created LibraryModel . The result will be an identifier for the resource type: com.vmware.content.Library .

Implemented in vmware::content::LocalLibraryStub.

void vmware::content::LocalLibrary::Delete ( string  libraryId)

Deletes the specified local library.

Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

Exceptions:
vmware.vapi.std.errors.InvalidElementTypeif the library specified by libraryId is not a local library.
vmware.vapi.std.errors.NotFoundif the library specified by libraryId does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the library contains a library item that cannot be deleted in its current state. For example, the library item contains a virtual machine template and a virtual machine is checked out of the library item.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.DeleteLocalLibrary .
Parameters:
libraryIdIdentifier of the local library to delete. The parameter must be an identifier for the resource type: com.vmware.content.Library .

Implemented in vmware::content::LocalLibraryStub.

void vmware::content::LocalLibrary::Delete ( string  libraryId,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Deletes the specified local library.

Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

Exceptions:
vmware.vapi.std.errors.InvalidElementTypeif the library specified by libraryId is not a local library.
vmware.vapi.std.errors.NotFoundif the library specified by libraryId does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the library contains a library item that cannot be deleted in its current state. For example, the library item contains a virtual machine template and a virtual machine is checked out of the library item.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.DeleteLocalLibrary .
Parameters:
libraryIdIdentifier of the local library to delete. The parameter must be an identifier for the resource type: com.vmware.content.Library .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::content::LocalLibraryStub.

global::System.Threading.Tasks.Task vmware::content::LocalLibrary::DeleteAsync ( string  libraryId,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Deletes the specified local library.

Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

Exceptions:
vmware.vapi.std.errors.InvalidElementTypeif the library specified by libraryId is not a local library.
vmware.vapi.std.errors.NotFoundif the library specified by libraryId does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the library contains a library item that cannot be deleted in its current state. For example, the library item contains a virtual machine template and a virtual machine is checked out of the library item.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.DeleteLocalLibrary .
Parameters:
libraryIdIdentifier of the local library to delete. The parameter must be an identifier for the resource type: com.vmware.content.Library .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::content::LocalLibraryStub.

global::System.Threading.Tasks.Task vmware::content::LocalLibrary::DeleteAsync ( string  libraryId)

Deletes the specified local library.

Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

Exceptions:
vmware.vapi.std.errors.InvalidElementTypeif the library specified by libraryId is not a local library.
vmware.vapi.std.errors.NotFoundif the library specified by libraryId does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the library contains a library item that cannot be deleted in its current state. For example, the library item contains a virtual machine template and a virtual machine is checked out of the library item.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.DeleteLocalLibrary .
Parameters:
libraryIdIdentifier of the local library to delete. The parameter must be an identifier for the resource type: com.vmware.content.Library .

Implemented in vmware::content::LocalLibraryStub.

vmware.content.LibraryModel vmware::content::LocalLibrary::Get ( string  libraryId)

Returns a given local library.

Exceptions:
vmware.vapi.std.errors.NotFoundif the library specified by libraryId does not exist.
vmware.vapi.std.errors.InvalidElementTypeif the library specified by libraryId is not a local library.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read .
Parameters:
libraryIdIdentifier of the local library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library .
Returns:
The LibraryModel instance associated with libraryId .

Implemented in vmware::content::LocalLibraryStub.

vmware.content.LibraryModel vmware::content::LocalLibrary::Get ( string  libraryId,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns a given local library.

Exceptions:
vmware.vapi.std.errors.NotFoundif the library specified by libraryId does not exist.
vmware.vapi.std.errors.InvalidElementTypeif the library specified by libraryId is not a local library.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read .
Parameters:
libraryIdIdentifier of the local library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
The LibraryModel instance associated with libraryId .

Implemented in vmware::content::LocalLibraryStub.

global::System.Threading.Tasks.Task<vmware.content.LibraryModel> vmware::content::LocalLibrary::GetAsync ( string  libraryId)

Returns a given local library.

Exceptions:
vmware.vapi.std.errors.NotFoundif the library specified by libraryId does not exist.
vmware.vapi.std.errors.InvalidElementTypeif the library specified by libraryId is not a local library.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read .
Parameters:
libraryIdIdentifier of the local library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library .
Returns:
The LibraryModel instance associated with libraryId .

Implemented in vmware::content::LocalLibraryStub.

global::System.Threading.Tasks.Task<vmware.content.LibraryModel> vmware::content::LocalLibrary::GetAsync ( string  libraryId,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns a given local library.

Exceptions:
vmware.vapi.std.errors.NotFoundif the library specified by libraryId does not exist.
vmware.vapi.std.errors.InvalidElementTypeif the library specified by libraryId is not a local library.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read .
Parameters:
libraryIdIdentifier of the local library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
The LibraryModel instance associated with libraryId .

Implemented in vmware::content::LocalLibraryStub.

global::System.Collections.Generic.List<string> vmware::content::LocalLibrary::List ( )

Returns the identifiers of all local libraries in the Content Library.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
Returns:
The list of identifiers of all local libraries in the Content Library. The result will contain identifiers for the resource type: com.vmware.content.Library .

Implemented in vmware::content::LocalLibraryStub.

global::System.Collections.Generic.List<string> vmware::content::LocalLibrary::List ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns the identifiers of all local libraries in the Content Library.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
Returns:
The list of identifiers of all local libraries in the Content Library. The result will contain identifiers for the resource type: com.vmware.content.Library .

Implemented in vmware::content::LocalLibraryStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<string> > vmware::content::LocalLibrary::ListAsync ( )

Returns the identifiers of all local libraries in the Content Library.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
Returns:
The list of identifiers of all local libraries in the Content Library. The result will contain identifiers for the resource type: com.vmware.content.Library .

Implemented in vmware::content::LocalLibraryStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<string> > vmware::content::LocalLibrary::ListAsync ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns the identifiers of all local libraries in the Content Library.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
Returns:
The list of identifiers of all local libraries in the Content Library. The result will contain identifiers for the resource type: com.vmware.content.Library .

Implemented in vmware::content::LocalLibraryStub.

void vmware::content::LocalLibrary::Publish ( string  libraryId,
global::System.Collections.Generic.List< vmware.content.LocalLibraryTypes.DestinationSpec subscriptions 
)

Publishes the library to specified subscriptions.

If no subscriptions are specified, then publishes the library to all its subscriptions. This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by libraryId does not exist.
vmware.vapi.std.errors.InvalidArgumentIf one or more subscriptions is not valid.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by libraryId is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by libraryId is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.PublishLibrary .
Parameters:
libraryIdIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionsThe list of subscriptions to publish this library to.

Implemented in vmware::content::LocalLibraryStub.

void vmware::content::LocalLibrary::Publish ( string  libraryId,
global::System.Collections.Generic.List< vmware.content.LocalLibraryTypes.DestinationSpec subscriptions,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Publishes the library to specified subscriptions.

If no subscriptions are specified, then publishes the library to all its subscriptions. This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by libraryId does not exist.
vmware.vapi.std.errors.InvalidArgumentIf one or more subscriptions is not valid.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by libraryId is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by libraryId is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.PublishLibrary .
Parameters:
libraryIdIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionsThe list of subscriptions to publish this library to.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::content::LocalLibraryStub.

global::System.Threading.Tasks.Task vmware::content::LocalLibrary::PublishAsync ( string  libraryId,
global::System.Collections.Generic.List< vmware.content.LocalLibraryTypes.DestinationSpec subscriptions 
)

Publishes the library to specified subscriptions.

If no subscriptions are specified, then publishes the library to all its subscriptions. This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by libraryId does not exist.
vmware.vapi.std.errors.InvalidArgumentIf one or more subscriptions is not valid.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by libraryId is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by libraryId is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.PublishLibrary .
Parameters:
libraryIdIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionsThe list of subscriptions to publish this library to.

Implemented in vmware::content::LocalLibraryStub.

global::System.Threading.Tasks.Task vmware::content::LocalLibrary::PublishAsync ( string  libraryId,
global::System.Collections.Generic.List< vmware.content.LocalLibraryTypes.DestinationSpec subscriptions,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Publishes the library to specified subscriptions.

If no subscriptions are specified, then publishes the library to all its subscriptions. This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by libraryId does not exist.
vmware.vapi.std.errors.InvalidArgumentIf one or more subscriptions is not valid.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by libraryId is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by libraryId is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.PublishLibrary .
Parameters:
libraryIdIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionsThe list of subscriptions to publish this library to.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::content::LocalLibraryStub.

void vmware::content::LocalLibrary::Update ( string  libraryId,
vmware.content.LibraryModel  updateSpec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Updates the properties of a local library.

This is an incremental update to the local library. Fields that are null in the update specification will be left unchanged.

Exceptions:
vmware.vapi.std.errors.NotFoundif the library specified by libraryId does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the library specified by libraryId is a published library with JSON persistence enabled (see library.PublishInfo.persistJsonEnabled ) and the content of the library has been deleted from the storage backings (see LibraryModel.storageBackings ) associated with it.
vmware.vapi.std.errors.InvalidElementTypeif the library specified by libraryId is not a local library.
vmware.vapi.std.errors.InvalidArgumentif the updateSpec is not valid.
vmware.vapi.std.errors.InvalidArgumentif the library.PublishInfo.currentPassword in the updateSpec does not match the existing password of the published library.
vmware.vapi.std.errors.ResourceBusyif the LibraryModel.version of updateSpec is null and the library is being concurrently updated by another user.
vmware.vapi.std.errors.ConcurrentChangeif the LibraryModel.version of updateSpec is not equal to the current version of the library.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLocalLibrary .
Parameters:
libraryIdIdentifier of the local library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library .
updateSpecSpecification of the new property values to set on the local library.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::content::LocalLibraryStub.

void vmware::content::LocalLibrary::Update ( string  libraryId,
vmware.content.LibraryModel  updateSpec 
)

Updates the properties of a local library.

This is an incremental update to the local library. Fields that are null in the update specification will be left unchanged.

Exceptions:
vmware.vapi.std.errors.NotFoundif the library specified by libraryId does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the library specified by libraryId is a published library with JSON persistence enabled (see library.PublishInfo.persistJsonEnabled ) and the content of the library has been deleted from the storage backings (see LibraryModel.storageBackings ) associated with it.
vmware.vapi.std.errors.InvalidElementTypeif the library specified by libraryId is not a local library.
vmware.vapi.std.errors.InvalidArgumentif the updateSpec is not valid.
vmware.vapi.std.errors.InvalidArgumentif the library.PublishInfo.currentPassword in the updateSpec does not match the existing password of the published library.
vmware.vapi.std.errors.ResourceBusyif the LibraryModel.version of updateSpec is null and the library is being concurrently updated by another user.
vmware.vapi.std.errors.ConcurrentChangeif the LibraryModel.version of updateSpec is not equal to the current version of the library.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLocalLibrary .
Parameters:
libraryIdIdentifier of the local library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library .
updateSpecSpecification of the new property values to set on the local library.

Implemented in vmware::content::LocalLibraryStub.

global::System.Threading.Tasks.Task vmware::content::LocalLibrary::UpdateAsync ( string  libraryId,
vmware.content.LibraryModel  updateSpec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Updates the properties of a local library.

This is an incremental update to the local library. Fields that are null in the update specification will be left unchanged.

Exceptions:
vmware.vapi.std.errors.NotFoundif the library specified by libraryId does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the library specified by libraryId is a published library with JSON persistence enabled (see library.PublishInfo.persistJsonEnabled ) and the content of the library has been deleted from the storage backings (see LibraryModel.storageBackings ) associated with it.
vmware.vapi.std.errors.InvalidElementTypeif the library specified by libraryId is not a local library.
vmware.vapi.std.errors.InvalidArgumentif the updateSpec is not valid.
vmware.vapi.std.errors.InvalidArgumentif the library.PublishInfo.currentPassword in the updateSpec does not match the existing password of the published library.
vmware.vapi.std.errors.ResourceBusyif the LibraryModel.version of updateSpec is null and the library is being concurrently updated by another user.
vmware.vapi.std.errors.ConcurrentChangeif the LibraryModel.version of updateSpec is not equal to the current version of the library.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLocalLibrary .
Parameters:
libraryIdIdentifier of the local library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library .
updateSpecSpecification of the new property values to set on the local library.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::content::LocalLibraryStub.

global::System.Threading.Tasks.Task vmware::content::LocalLibrary::UpdateAsync ( string  libraryId,
vmware.content.LibraryModel  updateSpec 
)

Updates the properties of a local library.

This is an incremental update to the local library. Fields that are null in the update specification will be left unchanged.

Exceptions:
vmware.vapi.std.errors.NotFoundif the library specified by libraryId does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the library specified by libraryId is a published library with JSON persistence enabled (see library.PublishInfo.persistJsonEnabled ) and the content of the library has been deleted from the storage backings (see LibraryModel.storageBackings ) associated with it.
vmware.vapi.std.errors.InvalidElementTypeif the library specified by libraryId is not a local library.
vmware.vapi.std.errors.InvalidArgumentif the updateSpec is not valid.
vmware.vapi.std.errors.InvalidArgumentif the library.PublishInfo.currentPassword in the updateSpec does not match the existing password of the published library.
vmware.vapi.std.errors.ResourceBusyif the LibraryModel.version of updateSpec is null and the library is being concurrently updated by another user.
vmware.vapi.std.errors.ConcurrentChangeif the LibraryModel.version of updateSpec is not equal to the current version of the library.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLocalLibrary .
Parameters:
libraryIdIdentifier of the local library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library .
updateSpecSpecification of the new property values to set on the local library.

Implemented in vmware::content::LocalLibraryStub.


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