mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-23 01:49:59 -05:00
1329 lines
99 KiB
HTML
1329 lines
99 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<title>com.vmware.content package — vSphere Automation SDK for Python 6.6.1 documentation</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: './',
|
||
|
|
VERSION: '6.6.1',
|
||
|
|
COLLAPSE_INDEX: false,
|
||
|
|
FILE_SUFFIX: '.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
|
<link rel="top" title="vSphere Automation SDK for Python 6.6.1 documentation" href="index.html" />
|
||
|
|
<link rel="up" title="com.vmware package" href="com.vmware.html" />
|
||
|
|
<link rel="next" title="com.vmware.content.library package" href="com.vmware.content.library.html" />
|
||
|
|
<link rel="prev" title="com.vmware.cis package" href="com.vmware.cis.html" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
accesskey="I">index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.content.library.html" title="com.vmware.content.library package"
|
||
|
|
accesskey="N">next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.cis.html" title="com.vmware.cis package"
|
||
|
|
accesskey="P">previous</a> |</li>
|
||
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> »</li>
|
||
|
|
<li><a href="com.html" >com package</a> »</li>
|
||
|
|
<li><a href="com.vmware.html" accesskey="U">com.vmware package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body">
|
||
|
|
|
||
|
|
<div class="section" id="com-vmware-content-package">
|
||
|
|
<h1>com.vmware.content package<a class="headerlink" href="#com-vmware-content-package" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="section" id="subpackages">
|
||
|
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<div class="toctree-wrapper compound">
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.content.library.html">com.vmware.content.library package</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.library.html#subpackages">Subpackages</a><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.content.library.item.html">com.vmware.content.library.item package</a><ul>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.library.item.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.downloadsession_client">com.vmware.content.library.item.downloadsession_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.updatesession_client">com.vmware.content.library.item.updatesession_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.library.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.library.html#module-com.vmware.content.library.item_client">com.vmware.content.library.item_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.library.html#module-com.vmware.content.library">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="submodules">
|
||
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.content.library_client">
|
||
|
|
<span id="com-vmware-content-library-client-module"></span><h2>com.vmware.content.library_client module<a class="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>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library_client.Item">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content.library_client.</tt><tt class="descname">Item</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.content.library_client.Item" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Item</span></tt> class provides methods for managing library items.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library_client.Item.FindSpec">
|
||
|
|
<em class="property">class </em><tt class="descname">FindSpec</tt><big>(</big><em>name=None</em>, <em>library_id=None</em>, <em>source_id=None</em>, <em>type=None</em>, <em>cached=None</em><big>)</big><a class="headerlink" href="#com.vmware.content.library_client.Item.FindSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Item.FindSpec</span></tt> class specifies the properties that can be used as a
|
||
|
|
filter to find library items. When multiple attributes are specified, all
|
||
|
|
properties of the item must match the specification.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The name of the library item. The name is case-insensitive. See
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.name</span></tt>.
|
||
|
|
If not specified all library item names are searched.</li>
|
||
|
|
<li><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The identifier of the library containing the item. See
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.library_id</span></tt>.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>. When methods return a value of this
|
||
|
|
class as a return value, the attribute will be an identifier for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.
|
||
|
|
If not specified all libraries are searched.</li>
|
||
|
|
<li><strong>source_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The identifier of the library item as reported by the publisher.
|
||
|
|
See <tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.source_id</span></tt>.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>. When methods return a value of
|
||
|
|
this class as a return value, the attribute will be an identifier
|
||
|
|
for the resource type: <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.
|
||
|
|
If not specified all library items are searched.</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The type of the library item. The type is case-insensitive. See
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.type</span></tt>.
|
||
|
|
If not specified all types are searched.</li>
|
||
|
|
<li><strong>cached</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Whether the item is cached. Possible values are ‘true’ or ‘false’.
|
||
|
|
See <tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.cached</span></tt>.
|
||
|
|
If not specified all library items are searched.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library_client.Item.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Item.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'com.vmware.content.library.Item'</em><a class="headerlink" href="#com.vmware.content.library_client.Item.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Resource type for item.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library_client.Item.copy">
|
||
|
|
<tt class="descclassname">Item.</tt><tt class="descname">copy</tt><big>(</big><em>source_library_item_id</em>, <em>destination_create_spec</em>, <em>client_token=None</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>client_token</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – A unique token generated on the client for each copy request. The
|
||
|
|
token should be a universally unique identifier (UUID), for
|
||
|
|
example: <tt class="docutils literal"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></tt>. This token can
|
||
|
|
be used to guarantee idempotent copy.
|
||
|
|
If not specified copy is not idempotent.</li>
|
||
|
|
<li><strong>source_library_item_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the existing library item from which the content will
|
||
|
|
be copied.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</li>
|
||
|
|
<li><strong>destination_create_spec</strong> (<a class="reference internal" href="#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><tt class="xref py py-class docutils literal"><span class="pre">ItemModel</span></tt></a>) – Specification for the new library item to be created.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library item with <tt class="docutils literal"><span class="pre">source_library_item_id</span></tt> does not exist,
|
||
|
|
or if the library referenced by the <tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.library_id</span></tt>
|
||
|
|
property of <tt class="docutils literal"><span class="pre">destination_create_spec</span></tt> does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><dl class="first docutils">
|
||
|
|
<dt><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt> </dt>
|
||
|
|
<dd><p class="first last">if one of the following is true for the new library item:</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>name is empty</li>
|
||
|
|
<li>name exceeds 80 characters</li>
|
||
|
|
<li>description exceeds 1024 characters</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="docutils literal"><span class="pre">client_token</span></tt> does not conform to the UUID format.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.library_id</span></tt> property of
|
||
|
|
<tt class="docutils literal"><span class="pre">destination_create_spec</span></tt> refers to a subscribed library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the copy operation failed because the source or destination
|
||
|
|
library item is not accessible.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the parameter <tt class="docutils literal"><span class="pre">source_library_item_id</span></tt> requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
attribute <tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.library_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.AddLibraryItem</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library_client.Item.create">
|
||
|
|
<tt class="descclassname">Item.</tt><tt class="descname">create</tt><big>(</big><em>create_spec</em>, <em>client_token=None</em><big>)</big><a class="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
|
||
|
|
<a class="reference internal" href="com.vmware.content.library.html#com.vmware.content.library.item_client.UpdateSession" title="com.vmware.content.library.item_client.UpdateSession"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library.item_client.UpdateSession</span></tt></a> and
|
||
|
|
<a class="reference internal" href="com.vmware.content.library.item.html#com.vmware.content.library.item.updatesession_client.File" title="com.vmware.content.library.item.updatesession_client.File"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library.item.updatesession_client.File</span></tt></a>
|
||
|
|
classes.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>A library item cannot be created in a subscribed library.</div></blockquote>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>client_token</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – A unique token generated on the client for each creation request.
|
||
|
|
The token should be a universally unique identifier (UUID), for
|
||
|
|
example: <tt class="docutils literal"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></tt>. This token can
|
||
|
|
be used to guarantee idempotent creation.
|
||
|
|
If not specified creation is not idempotent.</li>
|
||
|
|
<li><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><tt class="xref py py-class docutils literal"><span class="pre">ItemModel</span></tt></a>) – Specification that defines the properties of the new library item.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Identifier of the new library item.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.library_id</span></tt> property of <tt class="docutils literal"><span class="pre">create_spec</span></tt>
|
||
|
|
refers to a library that does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><dl class="first docutils">
|
||
|
|
<dt><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt> </dt>
|
||
|
|
<dd><p class="first last">if one of the following is true for the new library item:</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>name is empty</li>
|
||
|
|
<li>name exceeds 80 characters</li>
|
||
|
|
<li>description exceeds 1024 characters</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="docutils literal"><span class="pre">client_token</span></tt> does not conform to the UUID format.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.library_id</span></tt> property of
|
||
|
|
<tt class="docutils literal"><span class="pre">destinationCreateSpec</span></tt> refers to a subscribed library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
attribute <tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.library_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.AddLibraryItem</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library_client.Item.delete">
|
||
|
|
<tt class="descclassname">Item.</tt><tt class="descname">delete</tt><big>(</big><em>library_item_id</em><big>)</big><a class="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
|
||
|
|
and syncing the subscribed library.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_item_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the library item to delete.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the library item with the given <tt class="docutils literal"><span class="pre">library_item_id</span></tt> is a member
|
||
|
|
of a subscribed library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library item with the specified <tt class="docutils literal"><span class="pre">library_item_id</span></tt> does not
|
||
|
|
exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the parameter <tt class="docutils literal"><span class="pre">library_item_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.DeleteLibraryItem</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library_client.Item.find">
|
||
|
|
<tt class="descclassname">Item.</tt><tt class="descname">find</tt><big>(</big><em>spec</em><big>)</big><a class="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
|
||
|
|
policy) library items matching the requested <a class="reference internal" href="#com.vmware.content.library_client.Item.FindSpec" title="com.vmware.content.library_client.Item.FindSpec"><tt class="xref py py-class docutils literal"><span class="pre">Item.FindSpec</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.content.library_client.Item.FindSpec" title="com.vmware.content.library_client.Item.FindSpec"><tt class="xref py py-class docutils literal"><span class="pre">Item.FindSpec</span></tt></a>) – Specification describing what properties to filter on.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content.library_client.Item.list" title="com.vmware.content.library_client.Item.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content.library_client.Item.list" title="com.vmware.content.library_client.Item.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of identifiers of all the visible library items
|
||
|
|
matching the given <tt class="docutils literal"><span class="pre">spec</span></tt>.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if no properties are specified in the <tt class="docutils literal"><span class="pre">spec</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
attribute <tt class="xref py py-attr docutils literal"><span class="pre">Item.FindSpec.library_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library_client.Item.get">
|
||
|
|
<tt class="descclassname">Item.</tt><tt class="descname">get</tt><big>(</big><em>library_item_id</em><big>)</big><a class="headerlink" href="#com.vmware.content.library_client.Item.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the <a class="reference internal" href="#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><tt class="xref py py-class docutils literal"><span class="pre">ItemModel</span></tt></a> with the given identifier.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_item_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the library item to return.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><tt class="xref py py-class docutils literal"><span class="pre">ItemModel</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><tt class="xref py py-class docutils literal"><span class="pre">ItemModel</span></tt></a> instance with the given <tt class="docutils literal"><span class="pre">library_item_id</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if no item with the given <tt class="docutils literal"><span class="pre">library_item_id</span></tt> exists.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the parameter <tt class="docutils literal"><span class="pre">library_item_id</span></tt> requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library_client.Item.list">
|
||
|
|
<tt class="descclassname">Item.</tt><tt class="descname">list</tt><big>(</big><em>library_id</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the library whose items should be returned.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content.library_client.Item.list" title="com.vmware.content.library_client.Item.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content.library_client.Item.list" title="com.vmware.content.library_client.Item.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of identifiers of the items in the library
|
||
|
|
specified by <tt class="docutils literal"><span class="pre">library_id</span></tt>.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library associated with <tt class="docutils literal"><span class="pre">library_id</span></tt> does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
parameter <tt class="docutils literal"><span class="pre">library_id</span></tt> requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library_client.Item.update">
|
||
|
|
<tt class="descclassname">Item.</tt><tt class="descname">update</tt><big>(</big><em>library_item_id</em>, <em>update_spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>library_item_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the library item to update.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</li>
|
||
|
|
<li><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><tt class="xref py py-class docutils literal"><span class="pre">ItemModel</span></tt></a>) – Specification of the properties to set.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library item specified by <tt class="docutils literal"><span class="pre">library_item_id</span></tt> does not
|
||
|
|
exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the library item corresponding to <tt class="docutils literal"><span class="pre">library_item_id</span></tt> is a
|
||
|
|
member of a subscribed library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><dl class="first docutils">
|
||
|
|
<dt><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt> </dt>
|
||
|
|
<dd><p class="first last">if one of the following is true for the <tt class="docutils literal"><span class="pre">update_spec</span></tt>:</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>name is empty</li>
|
||
|
|
<li>name exceeds 80 characters</li>
|
||
|
|
<li>description exceeds 1024 characters</li>
|
||
|
|
<li>version is not equal to the current version of the library item</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the parameter <tt class="docutils literal"><span class="pre">library_item_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.UpdateLibraryItem</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library_client.ItemModel">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content.library_client.</tt><tt class="descname">ItemModel</tt><big>(</big><em>id=None</em>, <em>library_id=None</em>, <em>content_version=None</em>, <em>creation_time=None</em>, <em>description=None</em>, <em>last_modified_time=None</em>, <em>last_sync_time=None</em>, <em>metadata_version=None</em>, <em>name=None</em>, <em>cached=None</em>, <em>size=None</em>, <em>type=None</em>, <em>version=None</em>, <em>source_id=None</em><big>)</big><a class="headerlink" href="#com.vmware.content.library_client.ItemModel" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ItemModel</span></tt> class represents a library item that has been stored in a
|
||
|
|
library.</p>
|
||
|
|
<p>A <tt class="docutils literal"><span class="pre">ItemModel</span></tt> represents a single logical unit to be managed within a
|
||
|
|
<a class="reference internal" href="com.vmware.html#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content_client.LibraryModel</span></tt></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
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.type</span></tt> 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 <a class="reference internal" href="com.vmware.html#com.vmware.content_client.Type" title="com.vmware.content_client.Type"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content_client.Type</span></tt></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 <a class="reference internal" href="#com.vmware.content.library_client.Item" title="com.vmware.content.library_client.Item"><tt class="xref py py-class docutils literal"><span class="pre">Item</span></tt></a> class and, for items in
|
||
|
|
subscribed libraries, the <a class="reference internal" href="#com.vmware.content.library_client.SubscribedItem" title="com.vmware.content.library_client.SubscribedItem"><tt class="xref py py-class docutils literal"><span class="pre">SubscribedItem</span></tt></a> class.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>. When methods return a value of
|
||
|
|
this class as a return value, the attribute will be an identifier
|
||
|
|
for the resource type: <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will not
|
||
|
|
be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods.
|
||
|
|
It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the
|
||
|
|
<a class="reference internal" href="com.vmware.html#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content_client.LibraryModel</span></tt></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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>. When methods return a value of this
|
||
|
|
class as a return value, the attribute will be an identifier for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.
|
||
|
|
This attribute must be provided for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>content_version</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The version of the file content list of this library item.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>creation_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – The date and time when this library item was created.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – A human-readable description for this library item.
|
||
|
|
This attribute is optional for the <tt class="docutils literal"><span class="pre">create</span></tt> method. Leaving it
|
||
|
|
None during creation will result in an empty string value. It will
|
||
|
|
always be present in the result of a <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> method. It
|
||
|
|
is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method. Leaving it None during
|
||
|
|
update indicates that the description remains unchanged.</li>
|
||
|
|
<li><strong>last_modified_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – <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 <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>last_sync_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – <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 <tt class="docutils literal"><span class="pre">create</span></tt> method. It is
|
||
|
|
optional in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods. It
|
||
|
|
is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>metadata_version</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <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 <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <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 <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>cached</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – 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 <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – 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 <tt class="docutils literal"><span class="pre">create</span></tt> method. It is
|
||
|
|
optional in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods. It
|
||
|
|
is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <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 <a class="reference internal" href="com.vmware.html#com.vmware.content_client.Type" title="com.vmware.content_client.Type"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content_client.Type</span></tt></a> class.
|
||
|
|
This attribute is optional for the <tt class="docutils literal"><span class="pre">create</span></tt> and <tt class="docutils literal"><span class="pre">update</span></tt>
|
||
|
|
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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <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 <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the result of a <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> method. It
|
||
|
|
is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method. Leaving it None during
|
||
|
|
update indicates that you do not need to detect concurrent updates.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>source_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the <a class="reference internal" href="#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><tt class="xref py py-class docutils literal"><span class="pre">ItemModel</span></tt></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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>. When methods return a value of
|
||
|
|
this class as a return value, the attribute will be an identifier
|
||
|
|
for the resource type: <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It is
|
||
|
|
optional in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods. It
|
||
|
|
is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library_client.OptimizationInfo">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content.library_client.</tt><tt class="descname">OptimizationInfo</tt><big>(</big><em>optimize_remote_publishing=None</em><big>)</big><a class="headerlink" href="#com.vmware.content.library_client.OptimizationInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">OptimizationInfo</span></tt> class defines different optimizations and
|
||
|
|
optimization parameters applied to particular library.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>optimize_remote_publishing</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – <p>If set to <tt class="docutils literal"><span class="pre">true</span></tt> 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 <tt class="docutils literal"><span class="pre">Vcenter</span></tt> 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 <tt class="docutils literal"><span class="pre">create</span></tt> method. If not
|
||
|
|
specified for the <tt class="docutils literal"><span class="pre">create</span></tt>, the default is for the library to not
|
||
|
|
be optmized for specific use case. It is not used for the
|
||
|
|
<tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library_client.PublishInfo">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content.library_client.</tt><tt class="descname">PublishInfo</tt><big>(</big><em>authentication_method=None</em>, <em>published=None</em>, <em>publish_url=None</em>, <em>user_name=None</em>, <em>password=None</em>, <em>persist_json_enabled=None</em><big>)</big><a class="headerlink" href="#com.vmware.content.library_client.PublishInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">PublishInfo</span></tt> class defines how a local library is published publicly
|
||
|
|
for synchronization to other libraries.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>authentication_method</strong> (<a class="reference internal" href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod" title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod"><tt class="xref py py-class docutils literal"><span class="pre">PublishInfo.AuthenticationMethod</span></tt></a>) – Indicates how a subscribed library should authenticate (BASIC,
|
||
|
|
NONE) to the published library endpoint.
|
||
|
|
This attribute must be provided for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>published</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Whether the local library is published.
|
||
|
|
This attribute must be provided for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>publish_url</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <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
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">SubscriptionInfo.subscription_url</span></tt> property when creating a
|
||
|
|
subscribed library.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>user_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The username to require for authentication.
|
||
|
|
This attribute is optional for the <tt class="docutils literal"><span class="pre">create</span></tt> and <tt class="docutils literal"><span class="pre">update</span></tt>
|
||
|
|
method. When the authentication is not required, the username can
|
||
|
|
be left None. When the authentication method is basic, the username
|
||
|
|
is ignored in the current release. It defaults to “vcsp”. It is
|
||
|
|
preferable to leave this unset. If specified, it must be set to
|
||
|
|
“vcsp”.</li>
|
||
|
|
<li><strong>password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The password to require for authentication.
|
||
|
|
This attribute is optional for the <tt class="docutils literal"><span class="pre">create</span></tt> method. When the
|
||
|
|
authentication method is
|
||
|
|
<a class="reference internal" href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE" title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE"><tt class="xref py py-attr docutils literal"><span class="pre">PublishInfo.AuthenticationMethod.NONE</span></tt></a>, the password can be
|
||
|
|
left None. When the authentication method is
|
||
|
|
<a class="reference internal" href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC" title="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC"><tt class="xref py py-attr docutils literal"><span class="pre">PublishInfo.AuthenticationMethod.BASIC</span></tt></a>, the password should
|
||
|
|
be a non-empty string. This attribute is optional for the
|
||
|
|
<tt class="docutils literal"><span class="pre">update</span></tt> method. Leaving it None during update indicates that the
|
||
|
|
password is not changed. This attribute is not used for the <tt class="docutils literal"><span class="pre">get</span></tt>
|
||
|
|
or <tt class="docutils literal"><span class="pre">list</span></tt> method.</li>
|
||
|
|
<li><strong>persist_json_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – <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 <tt class="xref py py-attr docutils literal"><span class="pre">SubscriptionInfo.subscription_url</span></tt>. 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 <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library_client.PublishInfo.AuthenticationMethod">
|
||
|
|
<em class="property">class </em><tt class="descname">AuthenticationMethod</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">PublishInfo.AuthenticationMethod</span></tt> class indicates how a subscribed
|
||
|
|
library should authenticate to the published library endpoint.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="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 <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">AuthenticationMethod</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC">
|
||
|
|
<tt class="descname">BASIC</tt><em class="property"> = AuthenticationMethod(string=u'BASIC')</em><a class="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
|
||
|
|
password.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE">
|
||
|
|
<tt class="descname">NONE</tt><em class="property"> = AuthenticationMethod(string=u'NONE')</em><a class="headerlink" href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Require no authentication.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library_client.StorageBacking">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content.library_client.</tt><tt class="descname">StorageBacking</tt><big>(</big><em>type=None</em>, <em>datastore_id=None</em>, <em>storage_uri=None</em><big>)</big><a class="headerlink" href="#com.vmware.content.library_client.StorageBacking" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">StorageBacking</span></tt> class defines a storage location where content in a
|
||
|
|
library will be stored. The storage location can either be a Datastore or
|
||
|
|
Other type.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.content.library_client.StorageBacking.Type" title="com.vmware.content.library_client.StorageBacking.Type"><tt class="xref py py-class docutils literal"><span class="pre">StorageBacking.Type</span></tt></a>) – Type (DATASTORE, OTHER) of <a class="reference internal" href="#com.vmware.content.library_client.StorageBacking" title="com.vmware.content.library_client.StorageBacking"><tt class="xref py py-class docutils literal"><span class="pre">StorageBacking</span></tt></a>.
|
||
|
|
This attribute must be provided for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>datastore_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datastore</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will be an identifier for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">Datastore</span></tt>.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.content.library_client.StorageBacking.Type.DATASTORE" title="com.vmware.content.library_client.StorageBacking.Type.DATASTORE"><tt class="xref py py-attr docutils literal"><span class="pre">StorageBacking.Type.DATASTORE</span></tt></a>.</li>
|
||
|
|
<li><strong>storage_uri</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <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><a class="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><a class="reference external" href="nfs://server/path">nfs://server/path</a> (for vCenter Server Appliance only) - Specifies
|
||
|
|
an NFS Version 3 server. The <a class="reference external" href="nfs://server:/path">nfs://server:/path</a> format is also
|
||
|
|
supported.</li>
|
||
|
|
<li><a class="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><a class="reference external" href="nfs://server:/path">nfs://server:/path</a> (for vCenter Server Appliance only)</li>
|
||
|
|
<li><a class="reference external" href="file://unc-server/path">file://unc-server/path</a> (for vCenter Server for Windows only)</li>
|
||
|
|
<li><a class="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><a class="reference external" href="nfs://server:/path">nfs://server:/path</a> (for vCenter Server Appliance only)</li>
|
||
|
|
<li><a class="reference external" href="file://unc-server/path">file://unc-server/path</a> (for vCenter Server for Windows only)</li>
|
||
|
|
<li><a class="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 <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.content.library_client.StorageBacking.Type.OTHER" title="com.vmware.content.library_client.StorageBacking.Type.OTHER"><tt class="xref py py-attr docutils literal"><span class="pre">StorageBacking.Type.OTHER</span></tt></a>.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library_client.StorageBacking.Type">
|
||
|
|
<em class="property">class </em><tt class="descname">Type</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.content.library_client.StorageBacking.Type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">StorageBacking.Type</span></tt> class specifies the type of the
|
||
|
|
<a class="reference internal" href="#com.vmware.content.library_client.StorageBacking" title="com.vmware.content.library_client.StorageBacking"><tt class="xref py py-class docutils literal"><span class="pre">StorageBacking</span></tt></a>.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="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 <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">Type</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library_client.StorageBacking.Type.DATASTORE">
|
||
|
|
<tt class="descname">DATASTORE</tt><em class="property"> = Type(string=u'DATASTORE')</em><a class="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
|
||
|
|
formats:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>Virtual Machine File System (VMFS)</li>
|
||
|
|
<li>Network File System (NFS)</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library_client.StorageBacking.Type.OTHER">
|
||
|
|
<tt class="descname">OTHER</tt><em class="property"> = Type(string=u'OTHER')</em><a class="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>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>NFS (on vCenter Server Appliance)</li>
|
||
|
|
<li>SMB (on vCenter Server Appliance and vCenter Server for Windows)</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library_client.SubscribedItem">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content.library_client.</tt><tt class="descname">SubscribedItem</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.content.library_client.SubscribedItem" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">SubscribedItem</span></tt> class manages the unique features of library items
|
||
|
|
that are members of a subscribed library.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library_client.SubscribedItem.evict">
|
||
|
|
<tt class="descname">evict</tt><big>(</big><em>library_item_id</em><big>)</big><a class="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
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.cached</span></tt> to false.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_item_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the library item whose content should be evicted.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library item specified by <tt class="docutils literal"><span class="pre">library_item_id</span></tt> does not
|
||
|
|
exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the library item specified by <tt class="docutils literal"><span class="pre">library_item_id</span></tt> is not a
|
||
|
|
member of a subscribed library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementConfiguration</span></tt>
|
||
|
|
if the library item specified by <tt class="docutils literal"><span class="pre">library_item_id</span></tt> is a member of
|
||
|
|
a subscribed library that does not synchronize on-demand.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the parameter <tt class="docutils literal"><span class="pre">library_item_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.EvictLibraryItem</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library_client.SubscribedItem.sync">
|
||
|
|
<tt class="descname">sync</tt><big>(</big><em>library_item_id</em>, <em>force_sync_content</em><big>)</big><a class="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
|
||
|
|
<a class="reference internal" href="#com.vmware.content.library_client.SubscriptionInfo" title="com.vmware.content.library_client.SubscriptionInfo"><tt class="xref py py-class docutils literal"><span class="pre">SubscriptionInfo</span></tt></a> of the library which owns the library item.</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>If <tt class="xref py py-attr docutils literal"><span class="pre">SubscriptionInfo.on_demand</span></tt> 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 <tt class="docutils literal"><span class="pre">force_sync_content</span></tt> parameter.</li>
|
||
|
|
<li>If <tt class="xref py py-attr docutils literal"><span class="pre">SubscriptionInfo.on_demand</span></tt> is false, then this call will
|
||
|
|
always synchronize the file content. The <tt class="docutils literal"><span class="pre">force_sync_content</span></tt>
|
||
|
|
parameter is ignored when the subscription is not on-demand.</li>
|
||
|
|
</ul>
|
||
|
|
<p>When the file content has been synchronized, the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ItemModel.cached</span></tt> attribute will be true.</p>
|
||
|
|
<p>This method will return immediately and create an asynchronous task to
|
||
|
|
perform the synchronization.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>library_item_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the library item to synchronize.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</li>
|
||
|
|
<li><strong>force_sync_content</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Whether to synchronize file content as well as metadata. This
|
||
|
|
parameter applies only if the subscription is on-demand.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library item specified by <tt class="docutils literal"><span class="pre">library_item_id</span></tt> could not be
|
||
|
|
found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the library item specified by <tt class="docutils literal"><span class="pre">library_item_id</span></tt> is not a
|
||
|
|
member of a subscribed library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the parameter <tt class="docutils literal"><span class="pre">library_item_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.SyncLibraryItem</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library_client.SubscriptionInfo">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content.library_client.</tt><tt class="descname">SubscriptionInfo</tt><big>(</big><em>authentication_method=None</em>, <em>automatic_sync_enabled=None</em>, <em>on_demand=None</em>, <em>password=None</em>, <em>ssl_thumbprint=None</em>, <em>subscription_url=None</em>, <em>user_name=None</em><big>)</big><a class="headerlink" href="#com.vmware.content.library_client.SubscriptionInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">SubscriptionInfo</span></tt> class defines the subscription behavior for a
|
||
|
|
subscribed library.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>authentication_method</strong> (<a class="reference internal" href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod" title="com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod"><tt class="xref py py-class docutils literal"><span class="pre">SubscriptionInfo.AuthenticationMethod</span></tt></a>) – Indicate how the subscribed library should authenticate (BASIC,
|
||
|
|
NONE) with the published library endpoint.
|
||
|
|
This attribute must be provided for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>automatic_sync_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Whether the library should participate in automatic library
|
||
|
|
synchronization. In order for automatic synchronization to happen,
|
||
|
|
the global
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">com.vmware.content_client.ConfigurationModel.automatic_sync_enabled</span></tt>
|
||
|
|
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
|
||
|
|
<a class="reference internal" href="com.vmware.html#com.vmware.content_client.SubscribedLibrary.sync" title="com.vmware.content_client.SubscribedLibrary.sync"><tt class="xref py py-func docutils literal"><span class="pre">com.vmware.content_client.SubscribedLibrary.sync()</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#com.vmware.content.library_client.SubscribedItem.sync" title="com.vmware.content.library_client.SubscribedItem.sync"><tt class="xref py py-func docutils literal"><span class="pre">SubscribedItem.sync()</span></tt></a>. In other words, manual synchronization
|
||
|
|
is still available even when automatic synchronization is disabled.
|
||
|
|
This attribute must be provided for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>on_demand</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – <p>Indicates whether a library item’s content will be synchronized
|
||
|
|
only on demand.</p>
|
||
|
|
<p>If this is set to <tt class="docutils literal"><span class="pre">true</span></tt>, 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 <a class="reference internal" href="#com.vmware.content.library_client.SubscribedItem.sync" title="com.vmware.content.library_client.SubscribedItem.sync"><tt class="xref py py-func docutils literal"><span class="pre">SubscribedItem.sync()</span></tt></a> call with
|
||
|
|
<tt class="docutils literal"><span class="pre">forceSyncContent</span></tt> set to true. Once content has been
|
||
|
|
synchronized, the content can removed with the
|
||
|
|
<a class="reference internal" href="#com.vmware.content.library_client.SubscribedItem.evict" title="com.vmware.content.library_client.SubscribedItem.evict"><tt class="xref py py-func docutils literal"><span class="pre">SubscribedItem.evict()</span></tt></a> call.</p>
|
||
|
|
<p>If this value is set to <tt class="docutils literal"><span class="pre">false</span></tt>, all content will be synchronized
|
||
|
|
in advance.
|
||
|
|
This attribute must be provided for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <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 <tt class="docutils literal"><span class="pre">create</span></tt> method. It will not
|
||
|
|
be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods.
|
||
|
|
It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>ssl_thumbprint</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <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 <tt class="docutils literal"><span class="pre">create</span></tt> method. It will not
|
||
|
|
be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods.
|
||
|
|
It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>subscription_url</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <p>The URL of the endpoint where the metadata for the remotely
|
||
|
|
published library is being served.</p>
|
||
|
|
<p>This URL can be the <tt class="xref py py-attr docutils literal"><span class="pre">PublishInfo.publish_url</span></tt> of the
|
||
|
|
published library (for example, <a class="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
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">PublishInfo.persist_json_enabled</span></tt>, the subscription URL can
|
||
|
|
be a URL pointing to the library JSON file on a datastore or remote
|
||
|
|
file system. The supported formats are:</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>vSphere 6.5</div></blockquote>
|
||
|
|
<ul>
|
||
|
|
<li>ds:///vmfs/volumes/{uuid}/mylibrary/lib.json (for datastore)</li>
|
||
|
|
<li><a class="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><a class="reference external" href="nfs://server/path/mylibrary/lib.json?version=4">nfs://server/path/mylibrary/lib.json?version=4</a> (for NFSv4 server
|
||
|
|
on vCenter Server Appliance)</li>
|
||
|
|
<li><a class="reference external" href="smb://server/path/mylibrary/lib.json">smb://server/path/mylibrary/lib.json</a> (for SMB server)</li>
|
||
|
|
</ul>
|
||
|
|
<blockquote>
|
||
|
|
<div>vSphere 6.0</div></blockquote>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference external" href="file://server/mylibrary/lib.json">file://server/mylibrary/lib.json</a> (for UNC server on vCenter
|
||
|
|
Server for Windows)</li>
|
||
|
|
<li><a class="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
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">StorageBacking.storage_uri</span></tt> 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 <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>user_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <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 <tt class="docutils literal"><span class="pre">create</span></tt> method. It is
|
||
|
|
optional in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods. It
|
||
|
|
is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod">
|
||
|
|
<em class="property">class </em><tt class="descname">AuthenticationMethod</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>Indicate how the subscribed library should authenticate with the published
|
||
|
|
library endpoint.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="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 <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">AuthenticationMethod</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod.BASIC">
|
||
|
|
<tt class="descname">BASIC</tt><em class="property"> = AuthenticationMethod(string=u'BASIC')</em><a class="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
|
||
|
|
password.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod.NONE">
|
||
|
|
<tt class="descname">NONE</tt><em class="property"> = AuthenticationMethod(string=u'NONE')</em><a class="headerlink" href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod.NONE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Require no authentication.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.content">
|
||
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-com.vmware.content" title="Permalink to this headline">¶</a></h2>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar">
|
||
|
|
<div class="sphinxsidebarwrapper">
|
||
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#">com.vmware.content package</a><ul>
|
||
|
|
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
||
|
|
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.content.library_client">com.vmware.content.library_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.content">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h4>Previous topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.cis.html"
|
||
|
|
title="previous chapter">com.vmware.cis package</a></p>
|
||
|
|
<h4>Next topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.content.library.html"
|
||
|
|
title="next chapter">com.vmware.content.library package</a></p>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="_sources/com.vmware.content.txt"
|
||
|
|
rel="nofollow">Show Source</a></li>
|
||
|
|
</ul>
|
||
|
|
<div id="searchbox" style="display: none">
|
||
|
|
<h3>Quick search</h3>
|
||
|
|
<form class="search" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" />
|
||
|
|
<input type="submit" value="Go" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
<p class="searchtip" style="font-size: 90%">
|
||
|
|
Enter search terms or a module, class or function name.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
>index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.content.library.html" title="com.vmware.content.library package"
|
||
|
|
>next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.cis.html" title="com.vmware.cis package"
|
||
|
|
>previous</a> |</li>
|
||
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> »</li>
|
||
|
|
<li><a href="com.html" >com package</a> »</li>
|
||
|
|
<li><a href="com.vmware.html" >com.vmware package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2014-2017, VMware, Inc. All rights reserved.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|