1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-29 20:09:58 -05:00
vsphere-automation-sdk-python/vsphere/cloud/com.vmware.vcenter.vm_template.html

1149 lines
89 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vcenter.vm_template package &mdash; vSphere Automation SDK for Python. 7.0.0.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="vmware package" href="vmware.html" />
<link rel="prev" title="com.vmware.vcenter.vm.storage package" href="com.vmware.vcenter.vm.storage.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
</a>
<div class="version">
7.0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
<li>com.vmware.vcenter.vm_template package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.vm_template.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.vcenter.vm_template">
<span id="com-vmware-vcenter-vm-template-package"></span><h1>com.vmware.vcenter.vm_template package<a class="headerlink" href="#module-com.vmware.vcenter.vm_template" title="Permalink to this headline"></a></h1>
<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.vcenter.vm_template.library_items_client">
<span id="com-vmware-vcenter-vm-template-library-items-client-module"></span><h2>com.vmware.vcenter.vm_template.library_items_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm_template.library_items_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_template.library_items_client</span></code> module provides
classes and classes for managing virtual machine template library items. This
includes methods for checking out virtual machine template library items and
querying previous versions of checked in virtual machines.</p>
<dl class="class">
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm_template.library_items_client.</code><code class="sig-name descname">CheckOuts</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CheckOuts</span></code> class provides methods for managing the checkouts of a
library item containing a virtual machine template. This class provides
operations to check out a library item to update the virtual machine
template, and to check in the library item when the virtual machine changes
are complete. This class was added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="class">
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.CheckInSpec">
<em class="property">class </em><code class="sig-name descname">CheckInSpec</code><span class="sig-paren">(</span><em class="sig-param">message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.CheckInSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CheckOuts.CheckInSpec</span></code> class defines the information required to
check in a virtual machine into a library item. This class was added in
vSphere API 6.9.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Message describing the changes made to the virtual machine. This
attribute was added in vSphere API 6.9.1.</p>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.CheckOutSpec">
<em class="property">class </em><code class="sig-name descname">CheckOutSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">placement=None</em>, <em class="sig-param">powered_on=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.CheckOutSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CheckOuts.CheckOutSpec</span></code> class defines the information required to
check out a library item containing a virtual machine template. This class
was added in vSphere API 6.9.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Name of the virtual machine to check out of the library item. This
attribute was added in vSphere API 6.9.1.
This attribute is currently required. In the future, if this
attribute is None, the system will choose a suitable name for the
virtual machine.</p></li>
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.PlacementSpec" title="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.PlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckOuts.PlacementSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Information used to place the checked out virtual machine. This
attribute was added in vSphere API 6.9.1.
This attribute is currently required. In the future, if this
attribute is None, the system will place the virtual machine on a
suitable resource.</p>
<p>If specified, each attribute will be used for placement. If the
attributes result in disjoint placement, the operation will fail.
If the attributes along with the placement values of the source
virtual machine template result in disjoint placement, the
operation will fail.</p>
</p></li>
<li><p><strong>powered_on</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specifies whether the virtual machine should be powered on after
check out. This attribute was added in vSphere API 6.9.1.
If None, the virtual machine will not be powered on after check
out.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.Info">
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">time=None</em>, <em class="sig-param">user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CheckOuts.Info</span></code> class contains information about a checked out
virtual machine. This class was added in vSphere API 6.9.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) Date and time when the virtual machine was checked out. This
attribute was added in vSphere API 6.9.1.</p></li>
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the user who checked out the virtual machine. This
attribute was added in vSphere API 6.9.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.PlacementSpec">
<em class="property">class </em><code class="sig-name descname">PlacementSpec</code><span class="sig-paren">(</span><em class="sig-param">folder=None</em>, <em class="sig-param">resource_pool=None</em>, <em class="sig-param">host=None</em>, <em class="sig-param">cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.PlacementSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CheckOuts.PlacementSpec</span></code> class contains information used to place a
checked out virtual machine onto resources within the vCenter inventory.
The specified compute resource should have access to the storage associated
with the checked out virtual machine. This class was added in vSphere API
6.9.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Virtual machine folder into which the virtual machine should be
placed. This attribute was added in vSphere API 6.9.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
If None, the virtual machine will be placed in the same folder as
the source virtual machine template.</p></li>
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Resource pool into which the virtual machine should be placed. This
attribute was added in vSphere API 6.9.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.
If None, the system will attempt to choose a suitable resource pool
for the virtual machine; if a resource pool cannot be chosen, the
operation will fail.</p></li>
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Host onto which the virtual machine should be placed. If <code class="docutils literal notranslate"><span class="pre">host</span></code>
and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must
belong to <code class="docutils literal notranslate"><span class="pre">host</span></code>. If <code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">cluster</span></code> are both specified,
<code class="docutils literal notranslate"><span class="pre">host</span></code> must be a member of <code class="docutils literal notranslate"><span class="pre">cluster</span></code>. This attribute was added
in vSphere API 6.9.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
This attribute may be None if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">cluster</span></code> is
specified. If None, the system will attempt to choose a suitable
host for the virtual machine; if a host cannot be chosen, the
operation will fail.</p></li>
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Cluster onto which the virtual machine should be placed. If
<code class="docutils literal notranslate"><span class="pre">cluster</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified,
<code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must belong to <code class="docutils literal notranslate"><span class="pre">cluster</span></code>. If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and
<code class="docutils literal notranslate"><span class="pre">host</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a member of
<code class="docutils literal notranslate"><span class="pre">cluster</span></code>. This attribute was added in vSphere API 6.9.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
If <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">host</span></code> is specified, it is recommended
that this attribute be None.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.Summary">
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">vm=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CheckOuts.Summary</span></code> class contains commonly used information about a
checked out virtual machine. This class was added in vSphere API 6.9.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the checked out virtual machine. This attribute was
added in vSphere API 6.9.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.check_in">
<code class="sig-name descname">check_in</code><span class="sig-paren">(</span><em class="sig-param">template_library_item</em>, <em class="sig-param">vm</em>, <em class="sig-param">spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.check_in" title="Permalink to this definition"></a></dt>
<dd><p>Checks in a virtual machine into the library item. This method updates
the library item to contain the virtual machine being checked in as a
template. This template becomes the latest version of the library item.
The previous virtual machine template contained in the library item is
available as a backup and its information can be queried using the
<code class="docutils literal notranslate"><span class="pre">Versions</span></code> class. At most one previous version of a virtual machine
template is retained in the library item. This method was added in
vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the content library item in which the virtual machine
is checked in.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine to check into the library item.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.CheckInSpec" title="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.CheckInSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckOuts.CheckInSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification used to check in the virtual machine into the library
item.
This parameter is currently required. In the future, if this
parameter is None, the system will apply suitable defaults.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The new version of the library item.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if any of the specified parameters are invalid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the virtual machine identified by <code class="docutils literal notranslate"><span class="pre">vm</span></code> was not checked out of
the item specified by <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the method cannot be performed because of the virtual machines
current state. For example, if the virtual machine is not powered
off.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the item specified by <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> does not exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine specified by <code class="docutils literal notranslate"><span class="pre">vm</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if there is an error accessing a file from the virtual machine.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.CheckInTemplate</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.check_out">
<code class="sig-name descname">check_out</code><span class="sig-paren">(</span><em class="sig-param">template_library_item</em>, <em class="sig-param">spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.check_out" title="Permalink to this definition"></a></dt>
<dd><p>Checks out a library item containing a virtual machine template. This
method makes a copy of the source virtual machine template contained in
the library item as a virtual machine. The virtual machine is copied
with the same storage specification as the source virtual machine
template. Changes to the checked out virtual machine do not affect the
virtual machine template contained in the library item. To save these
changes back into the library item, <a class="reference internal" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.check_in" title="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.check_in"><code class="xref py py-func docutils literal notranslate"><span class="pre">CheckOuts.check_in()</span></code></a> the
virtual machine. To discard the changes, <a class="reference internal" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.delete" title="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.delete"><code class="xref py py-func docutils literal notranslate"><span class="pre">CheckOuts.delete()</span></code></a> the
virtual machine. This method was added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the content library item containing the source
virtual machine template to be checked out.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.CheckOutSpec" title="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.CheckOutSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckOuts.CheckOutSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification used to check out the source virtual machine template
as a virtual machine.
This parameter is currently required. In the future, if this
parameter is None, the system will apply suitable defaults.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Identifier of the virtual machine that was checked out of the
library item.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if a virtual machine with the name specified by
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CheckOuts.CheckOutSpec.name</span></code> already exists in the folder
specified by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CheckOuts.PlacementSpec.folder</span></code>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains invalid arguments.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the library item is a member of a subscribed library.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item specified by <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> cannot
be found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if there is an error accessing the files of the source virtual
machine template contained in the library item specified by
<code class="docutils literal notranslate"><span class="pre">template_library_item</span></code>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if the limit for the number of virtual machines checked out of a
library item (currently 1) has been exceeded.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.CheckOutTemplate</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Folder</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CheckOuts.PlacementSpec.folder</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CheckOuts.PlacementSpec.resource_pool</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CheckOuts.PlacementSpec.host</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">CheckOuts.PlacementSpec.cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">template_library_item</em>, <em class="sig-param">vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes the checked out virtual machine. This method was added in
vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the VM template library item.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the checked out virtual machine to delete.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item or virtual machine is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the virtual machine is not checked out of the library item.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the virtual machine is running (powered on).</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if the virtual machine is busy performing another operation.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if the virtual machines configuration state cannot be accessed.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.Inventory.Delete</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">template_library_item</em>, <em class="sig-param">vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the information about a checked out virtual machine. This
method was added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the VM template library item.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the checked out virtual machine.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.Info" title="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckOuts.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about a check out.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item or virtual machine is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the virtual machine is not checked out of the library item.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the library item does not contain a virtual machine template.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">template_library_item</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns commonly used information about the virtual machines that are
checked out of the library item. This method was added in vSphere API
6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the VM template library item.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.list" title="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.Summary" title="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckOuts.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of commonly used information about the check outs.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the library item does not contain a virtual machine template.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vm_template.library_items_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm_template.library_items_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vm_template.library_items_client.Versions">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm_template.library_items_client.</code><code class="sig-name descname">Versions</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.Versions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions</span></code> class provides methods for managing the live versions of
the virtual machine templates contained in a library item. Live versions
include the latest and previous virtual machine templates that are
available on disk. As new versions of virtual machine templates are checked
in, old versions of virtual machine templates are automatically purged.
Currently, at most one previous virtual machine template version is stored.
This class was added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="class">
<dt id="com.vmware.vcenter.vm_template.library_items_client.Versions.Info">
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">vm_template=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.Versions.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.Info</span></code> class contains information about a version of a
library item containing a virtual machine template. This class was added in
vSphere API 6.9.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm_template</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine template associated with the
library item version. This attribute is the managed object
identifier used to identify the virtual machine template in the
vSphere Management (SOAP) API. This attribute was added in vSphere
API 6.9.1.</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.vcenter.vm_template.library_items_client.Versions.RESOURCE_TYPE">
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.library.item.Version'</em><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.Versions.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for library item versions. This class attribute was added in
vSphere API 6.9.1.</p>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vm_template.library_items_client.Versions.RollbackSpec">
<em class="property">class </em><code class="sig-name descname">RollbackSpec</code><span class="sig-paren">(</span><em class="sig-param">message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.Versions.RollbackSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.RollbackSpec</span></code> class defines the information required to
rollback a virtual machine template library item to a previous version.
This class was added in vSphere API 6.9.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Message describing the reason for the rollback. This attribute was
added in vSphere API 6.9.1.</p>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vm_template.library_items_client.Versions.Summary">
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">version=None</em>, <em class="sig-param">vm_template=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.Versions.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.Summary</span></code> class contains commonly used information about a
version of a library item containing a virtual machine template. This class
was added in vSphere API 6.9.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The version of the library item. This attribute was added in
vSphere API 6.9.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>. When methods return a
value of this class as a return value, the attribute will be an
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>.</p></li>
<li><p><strong>vm_template</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine template associated with the
library item version. This attribute is the managed object
identifier used to identify the virtual machine template in the
vSphere Management (SOAP) API. This attribute was added in vSphere
API 6.9.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vm_template.library_items_client.Versions.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">template_library_item</em>, <em class="sig-param">version</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.Versions.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes the virtual machine template contained in the library item at
the specified version. This method was added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the VM template library item.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Version of the library item to delete.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item or version is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the specified version is the latest version of the library item.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the library item does not contain a virtual machine template.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if the virtual machine templates configuration state cannot be
accessed.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.DeleteLibraryItem</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>
referenced by the parameter <code class="docutils literal notranslate"><span class="pre">version</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vm_template.library_items_client.Versions.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">template_library_item</em>, <em class="sig-param">version</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.Versions.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about the live version of a library item containing
a virtual machine template. This method was added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the VM template library item.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Version of the library item.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_template.library_items_client.Versions.Info" title="com.vmware.vcenter.vm_template.library_items_client.Versions.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the specified library item version.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item or version is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the library item does not contain a virtual machine template.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>
referenced by the parameter <code class="docutils literal notranslate"><span class="pre">version</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vm_template.library_items_client.Versions.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">template_library_item</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.Versions.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns commonly used information about the live versions of a virtual
machine template library item. This method was added in vSphere API
6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the VM template library item.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_template.library_items_client.Versions.list" title="com.vmware.vcenter.vm_template.library_items_client.Versions.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm_template.library_items_client.Versions.Summary" title="com.vmware.vcenter.vm_template.library_items_client.Versions.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of commonly used information about the library item versions.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the library item does not contain a virtual machine template.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vm_template.library_items_client.Versions.rollback">
<code class="sig-name descname">rollback</code><span class="sig-paren">(</span><em class="sig-param">template_library_item</em>, <em class="sig-param">version</em>, <em class="sig-param">spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.Versions.rollback" title="Permalink to this definition"></a></dt>
<dd><p>Rollbacks a library item containing a virtual machine template to a
previous version. The virtual machine template at the specified version
becomes the latest virtual machine template with a new version
identifier. This method was added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the VM template library item.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Version of the library item to rollback.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template.library_items_client.Versions.RollbackSpec" title="com.vmware.vcenter.vm_template.library_items_client.Versions.RollbackSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.RollbackSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification to rollback the library item.
This parameter is currently required. In the future, if this
parameter is None, the system will apply suitable defaults.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The new version of the library item.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item or version is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the specified version is the latest version of the library item.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the library item does not contain a virtual machine template.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if a virtual machine is checked out of the library item.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.CheckInTemplate</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>
referenced by the parameter <code class="docutils literal notranslate"><span class="pre">version</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="vmware.html" class="btn btn-neutral float-right" title="vmware package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="com.vmware.vcenter.vm.storage.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.vm.storage package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, VMware, Inc.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>