<spanid="com-vmware-content-package"></span><h1>com.vmware.content package<aclass="headerlink"href="#module-com.vmware.content"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-content-library-client-module"></span><h2>com.vmware.content.library_client module<aclass="headerlink"href="#module-com.vmware.content.library_client"title="Permalink to this headline">¶</a></h2>
<p>The Content Library module provides classes and classes for defining and
managing the library’s items, subscription, publication, and storage.</p>
<dlclass="class">
<dtid="com.vmware.content.library_client.Item">
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library_client.</code><codeclass="descname">Item</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.Item"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<emclass="property">class </em><codeclass="descname">FindSpec</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>library_id=None</em>, <em>source_id=None</em>, <em>type=None</em>, <em>cached=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.Item.FindSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The name of the library item. The name is case-insensitive. See
If not specified all library item names are searched.</li>
<li><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the library containing the item. See
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>.
If not specified all libraries are searched.</li>
<li><strong>source_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the library item as reported by the publisher.
See <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ItemModel.source_id</span></code>.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>.
If not specified all library items are searched.</li>
<li><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of the library item. The type is case-insensitive. See
<li><strong>cached</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Whether the item is cached. Possible values are ‘true’ or ‘false’.
See <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ItemModel.cached</span></code>.
If not specified all library items are searched.</li>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.content.library.Item'</em><aclass="headerlink"href="#com.vmware.content.library_client.Item.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">copy</code><spanclass="sig-paren">(</span><em>source_library_item_id</em>, <em>destination_create_spec</em>, <em>client_token=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.Item.copy"title="Permalink to this definition">¶</a></dt>
<dd><p>Copies a library item.</p>
<p>Copying a library item allows a duplicate to be made within the same or
different library. The copy occurs by first creating a new library
item, whose identifier is returned. The content of the library item is
then copied asynchronously. This copy can be tracked as a task.</p>
<p>If the copy fails, Content Library Service will roll back the copy by
deleting any content that was already copied, and removing the new
library item. A failure during rollback may require manual cleanup by
an administrator.</p>
<blockquote>
<div>A library item cannot be copied into a subscribed library.</div></blockquote>
<li><strong>client_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A unique token generated on the client for each copy request. The
token should be a universally unique identifier (UUID), for
example: <codeclass="docutils literal notranslate"><spanclass="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
be used to guarantee idempotent copy.
If not specified copy is not idempotent.</li>
<li><strong>source_library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the existing library item from which the content will
be copied.
The parameter must be an identifier for the resource type:
<li><strong>destination_create_spec</strong> (<aclass="reference internal"href="#com.vmware.content.library_client.ItemModel"title="com.vmware.content.library_client.ItemModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ItemModel</span></code></a>) – Specification for the new library item to be created.</li>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">The identifier of the new library item into which the content is
being copied.
The return value will be an identifier for the resource type:
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>create_spec</em>, <em>client_token=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.Item.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new library item.</p>
<p>A new library item is created without any content. After creation,
content can be added through the
<aclass="reference internal"href="com.vmware.content.library.html#com.vmware.content.library.item_client.UpdateSession"title="com.vmware.content.library.item_client.UpdateSession"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library.item_client.UpdateSession</span></code></a> and
<li><strong>client_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A unique token generated on the client for each creation request.
The token should be a universally unique identifier (UUID), for
example: <codeclass="docutils literal notranslate"><spanclass="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
be used to guarantee idempotent creation.
If not specified creation is not idempotent.</li>
<li><strong>create_spec</strong> (<aclass="reference internal"href="#com.vmware.content.library_client.ItemModel"title="com.vmware.content.library_client.ItemModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ItemModel</span></code></a>) – Specification that defines the properties of the new library item.</li>
if the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ItemModel.library_id</span></code> property of <codeclass="docutils literal notranslate"><spanclass="pre">create_spec</span></code>
if the content of the library specified by the library ID (see
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ItemModel.library_id</span></code>) property of <codeclass="docutils literal notranslate"><spanclass="pre">create_spec</span></code> has been
deleted from the storage backings (see null) associated with it.</p>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>library_item_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.Item.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a library item.</p>
<p>This method will immediately remove the item from the library that owns
it. The content of the item will be asynchronously removed from the
storage backings. The content deletion can be tracked with a task. In
the event that the task fails, an administrator may need to manually
remove the files from the storage backing.</p>
<p>This method cannot be used to delete a library item that is a member of
a subscribed library. Removing an item from a subscribed library
requires deleting the item from the original published local library
<codeclass="descname">find</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.Item.find"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns identifiers of all the visible (as determined by authorization
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">The <aclass="reference internal"href="#com.vmware.content.library_client.Item.list"title="com.vmware.content.library_client.Item.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of identifiers of all the visible library items
matching the given <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code>.
The return value will contain identifiers for the resource type:
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>library_item_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.Item.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the <aclass="reference internal"href="#com.vmware.content.library_client.ItemModel"title="com.vmware.content.library_client.ItemModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ItemModel</span></code></a> with the given identifier.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>library_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.Item.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the identifiers of all items in the given library.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><pclass="first"><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library whose items should be returned.
The parameter must be an identifier for the resource type:
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">The <aclass="reference internal"href="#com.vmware.content.library_client.Item.list"title="com.vmware.content.library_client.Item.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of identifiers of the items in the library
specified by <codeclass="docutils literal notranslate"><spanclass="pre">library_id</span></code>.
The return value will contain identifiers for the resource type:
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>library_item_id</em>, <em>update_spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.Item.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the specified properties of a library item.</p>
<p>This is an incremental update to the library item. Attributes that are
None in the update specification are left unchanged.</p>
<p>This method cannot update a library item that is a member of a
subscribed library. Those items must be updated in the source published
library and synchronized to the subscribed library.</p>
<li><strong>library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library item to update.
The parameter must be an identifier for the resource type:
<li><strong>update_spec</strong> (<aclass="reference internal"href="#com.vmware.content.library_client.ItemModel"title="com.vmware.content.library_client.ItemModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ItemModel</span></code></a>) – Specification of the properties to set.</li>
<dd><pclass="first last">if one of the following is true for the <codeclass="docutils literal notranslate"><spanclass="pre">update_spec</span></code>:</p>
</dd>
</dl>
<ulclass="simple">
<li>name is empty</li>
<li>name exceeds 80 characters</li>
<li>description exceeds 2000 characters</li>
<li>version is not equal to the current version of the library item</li>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ItemModel</span></code> class represents a library item that has been stored in a
library.</p>
<p>A <codeclass="docutils literal notranslate"><spanclass="pre">ItemModel</span></code> represents a single logical unit to be managed within a
<aclass="reference internal"href="com.vmware.html#com.vmware.content_client.LibraryModel"title="com.vmware.content_client.LibraryModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content_client.LibraryModel</span></code></a>. Items contain the actual
content of a library, and their placement within a library determines
policies that affect that content such as publishing.</p>
<p>A library item can have a specified type, indicated with the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ItemModel.type</span></code> attribute. This property is associated with a
Content Library Service plugin that supports specific types and provides
additional services. The types available in a specific Content Library
Service can be queried using the <aclass="reference internal"href="com.vmware.html#com.vmware.content_client.Type"title="com.vmware.content_client.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content_client.Type</span></code></a>
class. Items of an unknown or unspecified type are treated generically.
Because subscribed library catalogs are synchronized as is, subscribing to
a remote Content Library Service effectively gives you a library with the
functionality of the remote service’s type adapter plugins, even if they
are not installed locally.</p>
<p>Items can be managed using the <aclass="reference internal"href="#com.vmware.content.library_client.Item"title="com.vmware.content.library_client.Item"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Item</span></code></a> class and, for items in
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A unique identifier for this library item.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will not
be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods.
It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</li>
<li><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the
<aclass="reference internal"href="com.vmware.html#com.vmware.content_client.LibraryModel"title="com.vmware.content_client.LibraryModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content_client.LibraryModel</span></code></a> to which this item
belongs.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>.
This attribute must be provided for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</li>
<li><strong>content_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The version of the file content list of this library item.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</li>
<li><strong>creation_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – The date and time when this library item was created.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A human-readable description for this library item.
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. Leaving it
None during creation will result in an empty string value. It will
always be present in the result of a <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> method. It
is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method. Leaving it None during
update indicates that the description remains unchanged.</li>
<li><strong>last_modified_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) –<p>The date and time when the metadata for this library item was last
changed.</p>
<p>This attribute is affected by changes to the properties or file
content of this item. It is not modified by changes to the tags of
the item, or by changes to the library which owns this item.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
</li>
<li><strong>last_sync_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) –<p>The date and time when this library item was last synchronized.</p>
<p>This attribute is updated every time a synchronization is triggered
on the library item, including when a synchronization is triggered
on the library to which this item belongs. The value is None for a
library item that belongs to a local library.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It is
optional in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods. It
is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
</li>
<li><strong>metadata_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>A version number for the metadata of this library item.</p>
<p>This value is incremented with each change to the metadata of this
item. Changes to name, description, and so on will increment this
value. The value is not incremented by changes to the content or
tags of the item or the library which owns it.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>A human-readable name for this library item.</p>
<p>The name may not be None or an empty string. The name does not have
to be unique, even within the same library.
This attribute must be provided for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
</li>
<li><strong>cached</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – The status that indicates whether the library item is on disk or
not. The library item is cached when all its files are on disk.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</li>
<li><strong>size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The library item size, in bytes. The size is the sum of the size
used on the storage backing for all the files in the item. When the
library item is not cached, the size is 0.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It is
optional in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods. It
is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</li>
<li><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>An optional type identifier which indicates the type adapter plugin
to use.</p>
<p>This attribute may be set to a non-empty string value that
corresponds to an identifier supported by a type adapter plugin
present in the Content Library Service. A type adapter plugin, if
present for the specified type, can provide additional information
and services around the item content. A type adapter can guide the
upload process by creating file entries that are in need of being
uploaded to complete an item.</p>
<p>The types and plugins supported by the Content Library Service can
be queried using the <aclass="reference internal"href="com.vmware.html#com.vmware.content_client.Type"title="com.vmware.content_client.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content_client.Type</span></code></a> class.
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code>
methods. During creation, if the type is left unspecified, or if
the type is specified but does not have a corresponding type
support plugin, then the type of the library item is considered to
be generic and all data is treated as generic files. During update,
if the type is not specified, then it is not updated.</p>
</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>A version number that is updated on metadata changes. This value is
used to validate update requests to provide optimistic concurrency
of changes.</p>
<p>This value represents a number that is incremented every time
library item properties, such as name or description, are changed.
It is not incremented by changes to the file content of the library
item, including adding or removing files. It is also not affected
by tagging the library item.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the result of a <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> method. It
is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method. Leaving it None during
update indicates that you do not need to detect concurrent updates.</p>
</li>
<li><strong>source_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the <aclass="reference internal"href="#com.vmware.content.library_client.ItemModel"title="com.vmware.content.library_client.ItemModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ItemModel</span></code></a> to which this item is
synchronized to if the item belongs to a subscribed library. The
value is None for a library item that belongs to a local library.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It is
optional in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods. It
is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library_client.</code><codeclass="descname">OptimizationInfo</code><spanclass="sig-paren">(</span><em>optimize_remote_publishing=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.OptimizationInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>optimize_remote_publishing</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) –<p>If set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> then library would be optimized for remote
publishing.</p>
<p>Turn it on if remote publishing is dominant use case for this
library. Remote publishing means here that publisher and
subscribers are not the part of the same <codeclass="docutils literal notranslate"><spanclass="pre">Vcenter</span></code> SSO domain.</p>
<p>Any optimizations could be done as result of turning on this
optimization during library creation. For example, library content
could be stored in different format but optimizations are not
limited to just storage format.</p>
<p>Note, that value of this toggle could be set only during creation
of the library and you would need to migrate your library in case
you need to change this value (optimize the library for different
use case).
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. If not
specified for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code>, the default is for the library to not
be optmized for specific use case. It is not used for the
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>authentication_method</strong> (<aclass="reference internal"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod"title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PublishInfo.AuthenticationMethod</span></code></a>) – Indicates how a subscribed library should authenticate (BASIC,
NONE) to the published library endpoint.
This attribute is required for the
<aclass="reference internal"href="com.vmware.html#com.vmware.content_client.LocalLibrary.create"title="com.vmware.content_client.LocalLibrary.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.content_client.LocalLibrary.create()</span></code></a> method. It is
and if None the value will not be changed. When the existing
authentication method is
<aclass="reference internal"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC"title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.AuthenticationMethod.BASIC</span></code></a> and authentication
is being turned off by updating this attribute to
<aclass="reference internal"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE"title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.AuthenticationMethod.NONE</span></code></a>, then the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.current_password</span></code> attribute is required. This
attribute will always be present in the results of the
<li><strong>published</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether the local library is published.
This attribute is required for the
<aclass="reference internal"href="com.vmware.html#com.vmware.content_client.LocalLibrary.create"title="com.vmware.content_client.LocalLibrary.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.content_client.LocalLibrary.create()</span></code></a> method. It is
and if None the value will not be changed. When the existing
authentication method is
<aclass="reference internal"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC"title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.AuthenticationMethod.BASIC</span></code></a> and the local
library is published, the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.current_password</span></code>
attribute is required before turning off publishing. This attribute
<li><strong>publish_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The URL to which the library metadata is published by the Content
Library Service.</p>
<p>This value can be used to set the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SubscriptionInfo.subscription_url</span></code> property when creating a
subscribed library.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
</li>
<li><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The username to require for authentication.
This attribute is optional for the
<aclass="reference internal"href="com.vmware.html#com.vmware.content_client.LocalLibrary.create"title="com.vmware.content_client.LocalLibrary.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.content_client.LocalLibrary.create()</span></code></a> and
<aclass="reference internal"href="com.vmware.html#com.vmware.content_client.LocalLibrary.update"title="com.vmware.content_client.LocalLibrary.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.content_client.LocalLibrary.update()</span></code></a> methods. When
the authentication method is
<aclass="reference internal"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE"title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.AuthenticationMethod.NONE</span></code></a>, the username can be
left None. When the authentication method is
<aclass="reference internal"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC"title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.AuthenticationMethod.BASIC</span></code></a>, the username is
ignored in the current release. It defaults to “vcsp”. It is
preferable to leave this None. If specified, it must be set to
“vcsp”.</li>
<li><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The new password to require for authentication.
This attribute is optional for the
<aclass="reference internal"href="com.vmware.html#com.vmware.content_client.LocalLibrary.create"title="com.vmware.content_client.LocalLibrary.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.content_client.LocalLibrary.create()</span></code></a> method. When
the authentication method is
<aclass="reference internal"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE"title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.AuthenticationMethod.NONE</span></code></a>, the password can be
left None. When the authentication method is
<aclass="reference internal"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC"title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.AuthenticationMethod.BASIC</span></code></a>, the password should
be a non-empty string. This attribute is optional for the
<li><strong>current_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The current password to verify. This attribute is available
starting in vSphere 6.7.
This attribute is unused for the
<aclass="reference internal"href="com.vmware.html#com.vmware.content_client.LocalLibrary.create"title="com.vmware.content_client.LocalLibrary.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.content_client.LocalLibrary.create()</span></code></a> method. This
attribute is optional for the
<aclass="reference internal"href="com.vmware.html#com.vmware.content_client.LocalLibrary.update"title="com.vmware.content_client.LocalLibrary.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.content_client.LocalLibrary.update()</span></code></a> method. When
the existing authentication method is
<aclass="reference internal"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE"title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.AuthenticationMethod.NONE</span></code></a>, the current password
can be left None. When the existing authentication method is
<aclass="reference internal"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC"title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.AuthenticationMethod.BASIC</span></code></a>, the current
password is verified before applying the new
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.password</span></code>, turning off authentication, or
unpublishing the library. This attribute is not used for the
<li><strong>persist_json_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) –<p>Whether library and library item metadata are persisted in the
storage backing as JSON files. This flag only applies if the local
library is published.</p>
<p>Enabling JSON persistence allows you to synchronize a subscribed
library manually instead of over HTTP. You copy the local library
content and metadata to another storage backing manually and then
create a subscribed library referencing the location of the library
JSON file in the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SubscriptionInfo.subscription_url</span></code>. When
the subscribed library’s storage backing matches the subscription
URL, files do not need to be copied to the subscribed library.</p>
<p>For a library backed by a datastore, the library JSON file will be
stored at the path contentlib-{library_id}/lib.json on the
datastore.</p>
<p>For a library backed by a remote file system, the library JSON file
will be stored at {library_id}/lib.json in the remote file system
path.
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
<emclass="property">class </em><codeclass="descname">AuthenticationMethod</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PublishInfo.AuthenticationMethod</span></code> class indicates how a subscribed
library should authenticate to the published library endpoint.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">BASIC</code><emclass="property"> = AuthenticationMethod(string='BASIC')</em><aclass="headerlink"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC"title="Permalink to this definition">¶</a></dt>
<dd><p>Require HTTP Basic authentication matching a specified username and
<codeclass="descname">NONE</code><emclass="property"> = AuthenticationMethod(string='NONE')</em><aclass="headerlink"href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library_client.</code><codeclass="descname">StorageBacking</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>datastore_id=None</em>, <em>storage_uri=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.StorageBacking"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.content.library_client.StorageBacking.Type"title="com.vmware.content.library_client.StorageBacking.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StorageBacking.Type</span></code></a>) – Type (DATASTORE, OTHER) of <aclass="reference internal"href="#com.vmware.content.library_client.StorageBacking"title="com.vmware.content.library_client.StorageBacking"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StorageBacking</span></code></a>.
This attribute must be provided for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</li>
<li><strong>datastore_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the datastore used to store the content in the
library.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.content.library_client.StorageBacking.Type.DATASTORE"title="com.vmware.content.library_client.StorageBacking.Type.DATASTORE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">StorageBacking.Type.DATASTORE</span></code></a>.</li>
<li><strong>storage_uri</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>URI identifying the location used to store the content in the
library.</p>
<blockquote>
<div>The following URI formats are supported:<p>vSphere 6.5</p>
</div></blockquote>
<ul>
<li><aclass="reference external"href="nfs://server/path?version=4">nfs://server/path?version=4</a> (for vCenter Server Appliance only) -
Specifies an NFS Version 4 server.</li>
<li><aclass="reference external"href="nfs://server/path">nfs://server/path</a> (for vCenter Server Appliance only) - Specifies
an NFS Version 3 server. The <aclass="reference external"href="nfs://server:/path">nfs://server:/path</a> format is also
supported.</li>
<li><aclass="reference external"href="smb://server/path">smb://server/path</a> - Specifies an SMB server or Windows share.</li>
</ul>
<blockquote>
<div>vSphere 6.0 Update 1</div></blockquote>
<ul>
<li><aclass="reference external"href="nfs://server:/path">nfs://server:/path</a> (for vCenter Server Appliance only)</li>
<li><aclass="reference external"href="file://unc-server/path">file://unc-server/path</a> (for vCenter Server for Windows only)</li>
<li><aclass="reference external"href="file:///mount/point">file:///mount/point</a> (for vCenter Server Appliance only) - Local
file URIs are supported only when the path is a local mount point
for an NFS file system. Use of file URIs is strongly discouraged.
Instead, use an NFS URI to specify the remote file system.</li>
</ul>
<blockquote>
<div>vSphere 6.0</div></blockquote>
<ul>
<li><aclass="reference external"href="nfs://server:/path">nfs://server:/path</a> (for vCenter Server Appliance only)</li>
<li><aclass="reference external"href="file://unc-server/path">file://unc-server/path</a> (for vCenter Server for Windows only)</li>
<li><aclass="reference external"href="file:///path">file:///path</a> - Local file URIs are supported but strongly
discouraged because it may interfere with the performance of
vCenter Server.</li>
</ul>
<p>This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.content.library_client.StorageBacking.Type.OTHER"title="com.vmware.content.library_client.StorageBacking.Type.OTHER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">StorageBacking.Type.OTHER</span></code></a>.</p>
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.StorageBacking.Type"title="Permalink to this definition">¶</a></dt>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DATASTORE</code><emclass="property"> = Type(string='DATASTORE')</em><aclass="headerlink"href="#com.vmware.content.library_client.StorageBacking.Type.DATASTORE"title="Permalink to this definition">¶</a></dt>
<dd><p>The content of the library will be stored on a datastore.</p>
<p>These are vCenter Server managed datastores, and are logical containers
that hide specifics of each storage device. Depending on the type of
storage you use, datastores can be backed by the following file system
<codeclass="descname">OTHER</code><emclass="property"> = Type(string='OTHER')</em><aclass="headerlink"href="#com.vmware.content.library_client.StorageBacking.Type.OTHER"title="Permalink to this definition">¶</a></dt>
<dd><p>The content of the library will be stored on a remote file system.</p>
<blockquote>
<div>Supports the following remote file systems:</div></blockquote>
<ulclass="simple">
<li>NFS (on vCenter Server Appliance)</li>
<li>SMB (on vCenter Server Appliance and vCenter Server for Windows)</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library_client.</code><codeclass="descname">SubscribedItem</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.SubscribedItem"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">evict</code><spanclass="sig-paren">(</span><em>library_item_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.SubscribedItem.evict"title="Permalink to this definition">¶</a></dt>
<dd><p>Evicts the cached content of a library item in a subscribed library.</p>
<p>This method allows the cached content of a library item to be removed
to free up storage capacity. This method will only work when a library
item is synchronized on-demand. When a library is not synchronized
on-demand, it always attempts to keep its cache up-to-date with the
published source. Evicting the library item will set
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ItemModel.cached</span></code> to false.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><pclass="first"><strong>library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library item whose content should be evicted.
The parameter must be an identifier for the resource type:
<codeclass="descname">sync</code><spanclass="sig-paren">(</span><em>library_item_id</em>, <em>force_sync_content</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.SubscribedItem.sync"title="Permalink to this definition">¶</a></dt>
<dd><p>Forces the synchronization of an individual library item in a
subscribed library.</p>
<p>Synchronizing an individual item will update that item’s metadata from
the remote source. If the source library item on the remote library has
been deleted, this method will delete the library item from the
subscribed library as well.</p>
<p>The default behavior of the synchronization is determined by the
<aclass="reference internal"href="#com.vmware.content.library_client.SubscriptionInfo"title="com.vmware.content.library_client.SubscriptionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SubscriptionInfo</span></code></a> of the library which owns the library item.</p>
<ulclass="simple">
<li>If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SubscriptionInfo.on_demand</span></code> is true, then the file content
is not synchronized by default. In this case, only the library item
metadata is synchronized. The file content may still be forcefully
synchronized by passing true for the <codeclass="docutils literal notranslate"><spanclass="pre">force_sync_content</span></code> parameter.</li>
<li>If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SubscriptionInfo.on_demand</span></code> is false, then this call will
always synchronize the file content. The <codeclass="docutils literal notranslate"><spanclass="pre">force_sync_content</span></code>
parameter is ignored when the subscription is not on-demand.</li>
</ul>
<p>When the file content has been synchronized, the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ItemModel.cached</span></code> attribute will be true.</p>
<p>This method will return immediately and create an asynchronous task to
<li><strong>library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library item to synchronize.
The parameter must be an identifier for the resource type:
<li><strong>force_sync_content</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether to synchronize file content as well as metadata. This
parameter applies only if the subscription is on-demand.</li>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>authentication_method</strong> (<aclass="reference internal"href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod"title="com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SubscriptionInfo.AuthenticationMethod</span></code></a>) – Indicate how the subscribed library should authenticate (BASIC,
NONE) with the published library endpoint.
This attribute must be provided for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</li>
<li><strong>automatic_sync_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether the library should participate in automatic library
synchronization. In order for automatic synchronization to happen,
option must also be true. The subscription is still active even
when automatic synchronization is turned off, but synchronization
is only activated with an explicit call to
<aclass="reference internal"href="com.vmware.html#com.vmware.content_client.SubscribedLibrary.sync"title="com.vmware.content_client.SubscribedLibrary.sync"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.content_client.SubscribedLibrary.sync()</span></code></a> or
<aclass="reference internal"href="#com.vmware.content.library_client.SubscribedItem.sync"title="com.vmware.content.library_client.SubscribedItem.sync"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">SubscribedItem.sync()</span></code></a>. In other words, manual synchronization
is still available even when automatic synchronization is disabled.
This attribute must be provided for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</li>
<li><strong>on_demand</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) –<p>Indicates whether a library item’s content will be synchronized
only on demand.</p>
<p>If this is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, then the library item’s metadata will
be synchronized but the item’s content (its files) will not be
synchronized. The Content Library Service will synchronize the
content upon request only. This can cause the first use of the
content to have a noticeable delay.</p>
<p>Items without synchronized content can be forcefully synchronized
in advance using the <aclass="reference internal"href="#com.vmware.content.library_client.SubscribedItem.sync"title="com.vmware.content.library_client.SubscribedItem.sync"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">SubscribedItem.sync()</span></code></a> call with
<codeclass="docutils literal notranslate"><spanclass="pre">forceSyncContent</span></code> set to true. Once content has been
<p>If this value is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, all content will be synchronized
in advance.
This attribute must be provided for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
</li>
<li><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The password to use when authenticating.</p>
<p>The password must be set when using a password-based authentication
method; empty strings are not allowed.
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will not
be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods.
It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
</li>
<li><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>An optional SHA-1 hash of the SSL certificate for the remote
endpoint.</p>
<p>If this value is defined the SSL certificate will be verified by
comparing it to the SSL thumbprint. The SSL certificate must verify
against the thumbprint. When specified, the standard certificate
chain validation behavior is not used. The certificate chain is
validated normally if this value is None.
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will not
be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods.
It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
</li>
<li><strong>subscription_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The URL of the endpoint where the metadata for the remotely
published library is being served.</p>
<p>This URL can be the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.publish_url</span></code> of the
published library (for example, <aclass="reference external"href="https://server/path/lib.json">https://server/path/lib.json</a>).</p>
<p>If the source content comes from a published library with
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PublishInfo.persist_json_enabled</span></code>, the subscription URL can
be a URL pointing to the library JSON file on a datastore or remote
<li><aclass="reference external"href="nfs://server/path/mylibrary/lib.json">nfs://server/path/mylibrary/lib.json</a> (for NFSv3 server on vCenter
Server Appliance)</li>
<li><aclass="reference external"href="nfs://server/path/mylibrary/lib.json?version=4">nfs://server/path/mylibrary/lib.json?version=4</a> (for NFSv4 server
<li><aclass="reference external"href="file://server/mylibrary/lib.json">file://server/mylibrary/lib.json</a> (for UNC server on vCenter
Server for Windows)</li>
<li><aclass="reference external"href="file:///path/mylibrary/lib.json">file:///path/mylibrary/lib.json</a> (for local file system)</li>
</ul>
<p>When you specify a DS subscription URL, the datastore must be on
the same vCenter Server as the subscribed library. When you specify
an NFS or SMB subscription URL, the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">StorageBacking.storage_uri</span></code> of the subscribed library must
be on the same remote file server and should share a common parent
path with the subscription URL.
This attribute must be provided for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
</li>
<li><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The username to use when authenticating.</p>
<p>The username must be set when using a password-based authentication
method. Empty strings are allowed for usernames.
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It is
optional in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods. It
is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
<emclass="property">class </em><codeclass="descname">AuthenticationMethod</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod"title="Permalink to this definition">¶</a></dt>
<p>Indicate how the subscribed library should authenticate with the published
library endpoint.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">BASIC</code><emclass="property"> = AuthenticationMethod(string='BASIC')</em><aclass="headerlink"href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod.BASIC"title="Permalink to this definition">¶</a></dt>
<dd><p>Require HTTP Basic authentication matching a specified username and
<codeclass="descname">NONE</code><emclass="property"> = AuthenticationMethod(string='NONE')</em><aclass="headerlink"href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod.NONE"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
