mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 12:00:00 -05:00
616 lines
37 KiB
HTML
616 lines
37 KiB
HTML
|
||
|
||
<!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 — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<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" />
|
||
|
||
|
||
<script src="_static/js/modernizr.min.js"></script>
|
||
|
||
</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">
|
||
6.8.1
|
||
</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.vcenter_client">com.vmware.vcenter_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> »</li>
|
||
|
||
<li><a href="com.html">com package</a> »</li>
|
||
|
||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||
|
||
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> »</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 checked out virtual machine template items.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm_template.library_items_client.</code><code class="descname">CheckOuts</code><span class="sig-paren">(</span><em>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. <strong>Warning:</strong> This class is part of a new feature in
|
||
development. It may be changed at any time and may not have all supported
|
||
functionality implemented.</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> (<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.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.CheckInInfo">
|
||
<em class="property">class </em><code class="descname">CheckInInfo</code><a class="headerlink" href="#com.vmware.vcenter.vm_template.library_items_client.CheckOuts.CheckInInfo" 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.CheckInInfo</span></code> class contains information about the result
|
||
of the check in method. This class is currently empty. In the future,
|
||
attributes will be added to summarize the check in result. <strong>Warning:</strong>
|
||
This class is part of a new feature in development. It may be changed at
|
||
any time and may not have all supported functionality implemented.</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>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.CheckOutSpec">
|
||
<em class="property">class </em><code class="descname">CheckOutSpec</code><span class="sig-paren">(</span><em>name=None</em>, <em>placement=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.
|
||
<strong>Warning:</strong> This class is part of a new feature in development. It may be
|
||
changed at any time and may not have all supported functionality
|
||
implemented.</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> (<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.
|
||
<strong>Warning:</strong> This attribute is part of a new feature in
|
||
development. It may be changed at any time and may not have all
|
||
supported functionality implemented.
|
||
This attribute is currently required. In the future, if this
|
||
attribute is None, the system will choose a suitable name for the
|
||
virtual machine.</li>
|
||
<li><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.
|
||
<strong>Warning:</strong> This attribute is part of a new feature in
|
||
development. It may be changed at any time and may not have all
|
||
supported functionality implemented.
|
||
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>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.PlacementSpec">
|
||
<em class="property">class </em><code class="descname">PlacementSpec</code><span class="sig-paren">(</span><em>folder=None</em>, <em>resource_pool=None</em>, <em>host=None</em>, <em>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. <strong>Warning:</strong> This class is part of a
|
||
new feature in development. It may be changed at any time and may not have
|
||
all supported functionality implemented.</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>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. <strong>Warning:</strong> This attribute is part of a new feature in
|
||
development. It may be changed at any time and may not have all
|
||
supported functionality implemented.
|
||
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.</li>
|
||
<li><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.
|
||
<strong>Warning:</strong> This attribute is part of a new feature in
|
||
development. It may be changed at any time and may not have all
|
||
supported functionality implemented.
|
||
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.</li>
|
||
<li><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>. <strong>Warning:</strong> This
|
||
attribute is part of a new feature in development. It may be
|
||
changed at any time and may not have all supported functionality
|
||
implemented.
|
||
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.</li>
|
||
<li><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>. <strong>Warning:</strong> This attribute is part of a new feature
|
||
in development. It may be changed at any time and may not have all
|
||
supported functionality implemented.
|
||
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.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.check_in">
|
||
<code class="descname">check_in</code><span class="sig-paren">(</span><em>template_library_item</em>, <em>vm</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. The original source virtual machine template contained in the
|
||
library item is no longer available. A virtual machine can only be
|
||
checked into the item that it was previously checked out of.
|
||
<strong>Warning:</strong> This method is part of a new feature in development. It
|
||
may be changed at any time and may not have all supported functionality
|
||
implemented.</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>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>.</li>
|
||
<li><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>.</li>
|
||
</ul>
|
||
</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.vcenter.vm_template.library_items_client.CheckOuts.CheckInInfo" title="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.CheckInInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckOuts.CheckInInfo</span></code></a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Information about the result of the check in method.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
||
if any of the specified parameters are invalid.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
||
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>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
||
if the method cannot be performed because of the virtual machine’s
|
||
current state. For example, if the virtual machine is not powered
|
||
off.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
if the item specified by <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> does not exist.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
if the virtual machine specified by <code class="docutils literal notranslate"><span class="pre">vm</span></code> does not exist.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
||
if there is an error accessing a file from the virtual machine.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
if the user that requested the method cannot be authenticated.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
if the user that requested the method is not authorized to perform
|
||
the method.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||
if the system reports an error while responding to the request.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="last simple">
|
||
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</li>
|
||
<li>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>.</li>
|
||
<li>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>.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.vm_template.library_items_client.CheckOuts.check_out">
|
||
<code class="descname">check_out</code><span class="sig-paren">(</span><em>template_library_item</em>, <em>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, delete the virtual machine.
|
||
<strong>Warning:</strong> This method is part of a new feature in development. It
|
||
may be changed at any time and may not have all supported functionality
|
||
implemented.</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>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>.</li>
|
||
<li><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.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">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>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code>
|
||
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>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
||
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains invalid arguments.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
if the library item specified by <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> cannot
|
||
be found.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
||
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>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
||
if the limit for the number of virtual machines checked out of a
|
||
library item (currently 1) has been exceeded.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
if the user that requested the method cannot be authenticated.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
if the user that requested the method is not authorized to perform
|
||
the method.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||
if the system reports an error while responding to the request.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="last simple">
|
||
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</li>
|
||
<li>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>.</li>
|
||
<li>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>.</li>
|
||
<li>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>.</li>
|
||
<li>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>.</li>
|
||
<li>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>.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</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="descclassname">com.vmware.vcenter.vm_template.library_items_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>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>
|
||
<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>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</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</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" 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>
|
||
© Copyright 2018, 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">
|
||
var DOCUMENTATION_OPTIONS = {
|
||
URL_ROOT:'./',
|
||
VERSION:'6.8.1',
|
||
LANGUAGE:'en',
|
||
COLLAPSE_INDEX:false,
|
||
FILE_SUFFIX:'.html',
|
||
HAS_SOURCE: true,
|
||
SOURCELINK_SUFFIX: '.txt'
|
||
};
|
||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |