A library_model is a container for a set of items which represent a usable set of files. The Content Library Service allows for multiple libraries to be created with separate authorization and sharing policies.
Each library_model is a container for a set of com.vmware.content.library.item_model instances. Each item is a logical object in a library, which may have multiple files.
A library_model may be local or subscribed. A local library has its source of truth about items within this Content Library Service. Items may be added to or removed from the library. A local library may also be private or published. When published, the library is exposed by a network endpoint and can be used by another Content Library Service for synchronization. A private local library cannot be used for synchronization.
A subscribed library is a library which gets its source of truth from another library that may be across a network in another Content Library Service. A subscribed library may have a different name and metadata from the library to which it subscribes, but the set of library items is always the same as those in the source library. Library items cannot be manually added to a subscribed library -- they can only be added by adding new items to the source library.
|
{
"creation_time": "2013-06-06T22:13:05", "description": "string", "id": "obj-103", "last_modified_time": "2013-06-06T22:13:05", "last_sync_time": "2013-06-06T22:13:05", "name": "string", "publish_info": { "authentication_method": "BASIC", "password": "secret string", "persist_json_enabled": true, "publish_url": "http://myurl.com", "published": true, "user_name": "string" }, "server_guid": "obj-103", "storage_backings": [ { "datastore_id": "obj-103", "storage_uri": "http://myurl.com", "type": "DATASTORE" }, { "datastore_id": "obj-103", "storage_uri": "http://myurl.com", "type": "DATASTORE" } ], "subscription_info": { "authentication_method": "BASIC", "automatic_sync_enabled": true, "on_demand": true, "password": "secret string", "ssl_thumbprint": "string", "subscription_url": "http://myurl.com", "user_name": "string" }, "type": "LOCAL", "version": "string" }
<?xml version="1.0" ?>
<ns0:LibraryModel xmlns:ns0="http://vmware.com/content" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <id>obj-103</id> <publish_info> <user_name>string</user_name> <publish_url>http://myurl.com</publish_url> <authentication_method>BASIC</authentication_method> <published>true</published> <persist_json_enabled>true</persist_json_enabled> <password>secret string</password> </publish_info> <storage_backings-array> <array-item> <datastore_id>obj-103</datastore_id> <storage_uri>http://myurl.com</storage_uri> <type>DATASTORE</type> </array-item> <array-item> <datastore_id>obj-103</datastore_id> <storage_uri>http://myurl.com</storage_uri> <type>DATASTORE</type> </array-item> </storage_backings-array> <last_modified_time>2013-06-06T22:13:05</last_modified_time> <description>string</description> <name>string</name> <creation_time>2013-06-06T22:13:05</creation_time> <subscription_info> <user_name>string</user_name> <ssl_thumbprint>string</ssl_thumbprint> <on_demand>true</on_demand> <automatic_sync_enabled>true</automatic_sync_enabled> <subscription_url>http://myurl.com</subscription_url> <authentication_method>BASIC</authentication_method> <password>secret string</password> </subscription_info> <type>LOCAL</type> <server_guid>obj-103</server_guid> <last_sync_time>2013-06-06T22:13:05</last_sync_time> <version>string</version> </ns0:LibraryModel> |
| Name | Type | Required | Description |
|---|---|---|---|
| id | ID | No. This field is not used for the create operation. It will not be present in the result of the get or list operations. It is not used for the update operation. |
An identifier which uniquely identifies this library_model. Id of type com.vmware.content.Library. |
| creation_time | date_time | Read | The date and time when this library was created. |
| description | string | Read | A human-readable description for this library. |
| last_modified_time | date_time | Read | The date and time when this library was last updated. This field is updated automatically when the library properties are changed. This field is not affected by adding, removing, or modifying a library item or its content within the library. Tagging the library or syncing the subscribed library does not alter this field. |
| last_sync_time | date_time | No. This field is not used for the create operation. It is optional in the result of the get or list operations. It is not used for the update operation. |
The date and time when this library was last synchronized. This field applies only to subscribed libraries. It is updated every time a synchronization is triggered on the library. The value is unset for a local library. |
| name | string | Create, Read | The name of the library. A Library is identified by a human-readable name. Library names cannot be undefined or an empty string. Names do not have to be unique. |
| storage_backings | List<storage_backing> | Create, Read | The list of storage backings which are available for this library. A com.vmware.content.library.storage_backing defines a storage location which can be used to store files for the library items in this library. Multiple storage locations are not currently supported but may become supported in future releases. |
| type | com.vmware.content.library_model.library_type | Create, Read | The type (LOCAL, SUBSCRIBED) of this library. This value can be used to determine what additional services and information can be available for this library. The library_type enumerated type defines the type of a com.vmware.content.library_model. The type of a library can be used to determine which additional services can be performed with a library. Values one of LOCAL: The library contents are defined and stored by the local Content Library Service installation. A local library can be retrieved and managed via the com.vmware.content.local_library. SUBSCRIBED: The library synchronizes its items and content from another published library. A subscribed library can be retrieved and managed via the com.vmware.content.subscribed_library. |
| version | string | Read | A version number which is updated on metadata changes. This value allows clients to detect concurrent updates and prevent accidental clobbering of data. This value represents a number which is incremented every time library properties, such as name or description, are changed. It is not incremented by changes to a library item within the library, including adding or removing items. It is also not affected by tagging the library. |
| publish_info | publish_info | No | Defines how this library is published so that it can be subscribed to by a remote subscribed library. The com.vmware.content.library.publish_info defines where and how the metadata for this local library is accessible. A local library is only published publically if com.vmware.content.library.publish_info.published is |
| subscription_info | subscription_info | No | Defines the subscription behavior for this Library. The com.vmware.content.library.subscription_info defines how this subscribed library synchronizes to a remote source. Setting the value will determine the remote source to which the library synchronizes, and how. Changing the subscription will result in synchronizing to a new source. If the new source differs from the old one, the old library items and data will be lost. Setting com.vmware.content.library.subscription_info.automatic_sync_enabled to false will halt subscription but will not remove existing cached data. |
| server_guid | ID | Read | The unique identifier of the vCenter server where the library exists. Id of type com.vmware.vcenter.VCenter. |
Copyright © 2014. All Rights Reserved.