|
VMware vSphere Automation SDK Perl
The VMware vSphere Automation SDK for Perl supports the client-side vSphere Automation API for access to vSphere services and capabilities
|
|
VMware vSphere Automation SDK Perl
The VMware vSphere Automation SDK for Perl supports the client-side vSphere Automation API for access to vSphere services and capabilities
|
Avaliable Methods | |
| public method | create () |
| public method | get () |
| public method | delete () |
| public method | new () |
| public method | update () |
| public method | list () |
The Com::Vmware::Content::LocalLibrary interface manages local libraries.
The Com::Vmware::Content::LocalLibrary interface provides support for creating and maintaining local library instances. A local library may also use the class Com::Vmware::Content::Library interface to manage general library functionality.
| public method Com::Vmware::Content::LocalLibrary::create | ( | ) |
Creates a new local library.
| client_token | [OPTIONAL] A 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. . The value must be String or None. |
| create_spec | [REQUIRED] Specification for the new local library. . The value must be Com::Vmware::Content::LibraryModel. |
| Identifier | of the newly created class Com::Vmware::Content::LibraryModel . The value will be an identifier for the resource type getQualifiedName(com.vmware.content.Library). The return type will be str |
| Com::Vmware::Vapi::Std::Errors::InvalidArgument | if the create_spec is not valid. |
| Com::Vmware::Vapi::Std::Errors::InvalidArgument | if the client_token does not conform to the UUID format. |
| Com::Vmware::Vapi::Std::Errors::Unsupported | if using multiple storage backings. |
Code:
| public method Com::Vmware::Content::LocalLibrary::delete | ( | ) |
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.
| library_id | [REQUIRED] Identifier of the local library to delete. The value must be an identifier for the resource type getQualifiedName(com.vmware.content.Library). . The value must be str. |
| Com::Vmware::Vapi::Std::Errors::InvalidElementType | if the library specified by library_id is not a local library. |
| Com::Vmware::Vapi::Std::Errors::NotFound | if the library specified by library_id does not exist. |
Code:
| public method Com::Vmware::Content::LocalLibrary::get | ( | ) |
Returns a given local library.
| library_id | [REQUIRED] Identifier of the local library to return. The value must be an identifier for the resource type getQualifiedName(com.vmware.content.Library). . The value must be str. |
| The | class Com::Vmware::Content::LibraryModel instance associated with library_id . The return type will be Com::Vmware::Content::LibraryModel |
| Com::Vmware::Vapi::Std::Errors::NotFound | if the library specified by library_id does not exist. |
| Com::Vmware::Vapi::Std::Errors::InvalidElementType | if the library specified by library_id is not a local library. |
Code:
| public method Com::Vmware::Content::LocalLibrary::list | ( | ) |
Returns the identifiers of all local libraries in the Content Library.
| The | list of identifiers of all local libraries in the Content Library. The value will be an identifier for the resource type getQualifiedName(com.vmware.content.Library). The return type will be Array of str |
Code:
| public method Com::Vmware::Content::LocalLibrary::new | ( | ) |
Constructor to initialize the object
| api_provider | - protocol connection to use with stubs created by this factory |
| StubConfig | - Stub's additional configuration |
| Blessed | object |
Code:
| public method Com::Vmware::Content::LocalLibrary::update | ( | ) |
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.
| library_id | [REQUIRED] Identifier of the local library to update. The value must be an identifier for the resource type getQualifiedName(com.vmware.content.Library). . The value must be str. |
| update_spec | [REQUIRED] Specification of the new property values to set on the local library. . The value must be Com::Vmware::Content::LibraryModel. |
| Com::Vmware::Vapi::Std::Errors::NotFound | if the library specified by library_id does not exist. |
| Com::Vmware::Vapi::Std::Errors::InvalidElementType | if the library specified by library_id is not a local library. |
| Com::Vmware::Vapi::Std::Errors::InvalidArgument | if the update_spec is not valid. |
| Com::Vmware::Vapi::Std::Errors::InvalidArgument | if the :attr:Com::Vmware::Content::LibraryModel.version of update_spec is not equal to the current version of the library. |
Code:
