mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 20:09:58 -05:00
2645 lines
233 KiB
HTML
2645 lines
233 KiB
HTML
|
|
||
|
|
|
||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<title>vcenter Package — vCloud Suite SDK for Python 6.0.0 documentation</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: '',
|
||
|
|
VERSION: '6.0.0',
|
||
|
|
COLLAPSE_INDEX: false,
|
||
|
|
FILE_SUFFIX: '.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
|
<link rel="top" title="vCloud Suite SDK for Python 6.0.0 documentation" href="index.html" />
|
||
|
|
<link rel="up" title="vmware Package" href="com.vmware.html" />
|
||
|
|
<link rel="next" title="vmware Package" href="vmware.html" />
|
||
|
|
<link rel="prev" title="std Package" href="com.vmware.vapi.std.html" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
accesskey="I">index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="vmware.html" title="vmware Package"
|
||
|
|
accesskey="N">next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.vapi.std.html" title="std Package"
|
||
|
|
accesskey="P">previous</a> |</li>
|
||
|
|
<li><a href="index.html">vCloud Suite SDK for Python 6.0.0 documentation</a> »</li>
|
||
|
|
<li><a href="com.html" >com Package</a> »</li>
|
||
|
|
<li><a href="com.vmware.html" accesskey="U">vmware Package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body">
|
||
|
|
|
||
|
|
<div class="section" id="vcenter-package">
|
||
|
|
<h1>vcenter Package<a class="headerlink" href="#vcenter-package" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="section" id="id1">
|
||
|
|
<h2><tt class="xref py py-mod docutils literal"><span class="pre">vcenter</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<span class="target" id="module-com.vmware.vcenter"></span></div>
|
||
|
|
<div class="section" id="module-com.vmware.vcenter.inventory_client">
|
||
|
|
<span id="inventory-client-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">inventory_client</span></tt> Module<a class="headerlink" href="#module-com.vmware.vcenter.inventory_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">com.vmware.vcenter.inventory_client</span></tt> component provides methods and
|
||
|
|
classes for retrieving vCenter datastore and network information for a given
|
||
|
|
<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of identifiers.</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.inventory_client.Datastore">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.inventory_client.</tt><tt class="descname">Datastore</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/inventory_client.html#Datastore"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Datastore" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Datastore</span></tt> class provides methods to retrieve information about
|
||
|
|
datastores.</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> (<a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt></a>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.inventory_client.Datastore.Info">
|
||
|
|
<em class="property">class </em><tt class="descname">Info</tt><big>(</big><em>type=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/inventory_client.html#Datastore.Info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Datastore.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Datastore.Info</span></tt> class contains information about a datastore.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Type of the datastore.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be one of <tt class="docutils literal"><span class="pre">Datastore</span></tt> or <tt class="docutils literal"><span class="pre">StoragePod</span></tt>. When
|
||
|
|
methods return a value of this class as a return value, the
|
||
|
|
attribute will be one of <tt class="docutils literal"><span class="pre">Datastore</span></tt> or <tt class="docutils literal"><span class="pre">StoragePod</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.inventory_client.Datastore.find">
|
||
|
|
<tt class="descclassname">Datastore.</tt><tt class="descname">find</tt><big>(</big><em>datastores</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/inventory_client.html#Datastore.find"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Datastore.find" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns datastore information for the specified datastores. The key in
|
||
|
|
the return value <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> is the datastore identifier and the
|
||
|
|
value in the <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> is the datastore information.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>datastores</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifiers of the datastores for which information will be
|
||
|
|
returned.
|
||
|
|
The parameter must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datastore</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> and (<a class="reference internal" href="#com.vmware.vcenter.inventory_client.Datastore.Info" title="com.vmware.vcenter.inventory_client.Datastore.Info"><tt class="xref py py-class docutils literal"><span class="pre">Datastore.Info</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>)</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Datastore information for the specified datastores. The key in the
|
||
|
|
return value <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> is the datastore identifier and the
|
||
|
|
value in the <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> is the datastore information.
|
||
|
|
The key in the return value <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> will be an identifier for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">Datastore</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
if no datastore can be found for one or more of the datastore
|
||
|
|
identifiers in <tt class="docutils literal"><span class="pre">datastores</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">Datastore</span></tt> referenced by the parameter
|
||
|
|
<tt class="docutils literal"><span class="pre">datastores</span></tt> requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.inventory_client.Network">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.inventory_client.</tt><tt class="descname">Network</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/inventory_client.html#Network"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Network" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Network</span></tt> class provides methods to retrieve information about
|
||
|
|
vCenter Server networks.</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> (<a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt></a>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.inventory_client.Network.Info">
|
||
|
|
<em class="property">class </em><tt class="descname">Info</tt><big>(</big><em>type=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/inventory_client.html#Network.Info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Network.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Network.Info</span></tt> class contains information about a vCenter Server
|
||
|
|
network.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Type of the vCenter Server network.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be one of <tt class="docutils literal"><span class="pre">Network</span></tt>,
|
||
|
|
<tt class="docutils literal"><span class="pre">DistributedVirtualPortgroup</span></tt>, or <tt class="docutils literal"><span class="pre">OpaqueNetwork</span></tt>. When methods
|
||
|
|
return a value of this class as a return value, the attribute will
|
||
|
|
be one of <tt class="docutils literal"><span class="pre">Network</span></tt>, <tt class="docutils literal"><span class="pre">DistributedVirtualPortgroup</span></tt>, or
|
||
|
|
<tt class="docutils literal"><span class="pre">OpaqueNetwork</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.inventory_client.Network.find">
|
||
|
|
<tt class="descclassname">Network.</tt><tt class="descname">find</tt><big>(</big><em>networks</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/inventory_client.html#Network.find"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Network.find" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns network information for the specified vCenter Server networks.
|
||
|
|
The key in the return value <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> is the network identifier and
|
||
|
|
the value in the <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> is the network information.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>networks</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifiers of the vCenter Server networks for which information
|
||
|
|
will be returned.
|
||
|
|
The parameter must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Network</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> and (<a class="reference internal" href="#com.vmware.vcenter.inventory_client.Network.Info" title="com.vmware.vcenter.inventory_client.Network.Info"><tt class="xref py py-class docutils literal"><span class="pre">Network.Info</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>)</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Network information for the specified vCenter Server networks. The
|
||
|
|
key in the return value <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> is the network identifier and
|
||
|
|
the value in the <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> is the network information.
|
||
|
|
The key in the return value <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> will be an identifier for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">Network</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
if no datastore can be found for one or more of the vCenter Server
|
||
|
|
network identifiers in <tt class="docutils literal"><span class="pre">networks</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">Network</span></tt> referenced by the parameter <tt class="docutils literal"><span class="pre">networks</span></tt>
|
||
|
|
requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.vcenter.ovf_client">
|
||
|
|
<span id="ovf-client-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">ovf_client</span></tt> Module<a class="headerlink" href="#module-com.vmware.vcenter.ovf_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">com.vmware.vcenter.ovf_client</span></tt> module provides services to capture and
|
||
|
|
deploy Open Virtualization Format (OVF) packages to and from the content
|
||
|
|
library.</p>
|
||
|
|
<p>It provides the ability to deploy OVF packages from the content library with
|
||
|
|
support for advanced network topologies, network services, creating virtual
|
||
|
|
appliances and virtual machines in hosts, resource pools or clusters. It also
|
||
|
|
provides the ability to export virtual appliances and virtual machines from
|
||
|
|
hosts, resource pools or clusters as OVF packages to the content library.</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.CertificateParams">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">CertificateParams</tt><big>(</big><em>issuer=None</em>, <em>subject=None</em>, <em>is_valid=None</em>, <em>is_self_signed=None</em>, <em>x509=None</em>, <em>type=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#CertificateParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.CertificateParams" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">CertificateParams</span></tt> class contains information about the public key
|
||
|
|
certificate used to sign the OVF package. This class will only be returned
|
||
|
|
if the OVF package is signed.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</div></blockquote>
|
||
|
|
<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>issuer</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Certificate issuer. For example: /C=US/ST=California/L=Palo
|
||
|
|
Alto/O=VMware, Inc.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>subject</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Certificate subject. For example:
|
||
|
|
/C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC
|
||
|
|
Avamar/CN=EMC Corporation.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>is_valid</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Is the certificate chain validated.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>is_self_signed</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Is the certificate self-signed.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>x509</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The X509 representation of the certificate.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Unique identifier describing the type of the OVF parameters. The
|
||
|
|
value is the name of the OVF parameters class.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.DeploymentOption">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">DeploymentOption</tt><big>(</big><em>key=None</em>, <em>label=None</em>, <em>description=None</em>, <em>default_choice=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#DeploymentOption"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DeploymentOption" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">DeploymentOption</span></tt> class contains the information about a deployment
|
||
|
|
option as defined in the OVF specification.</p>
|
||
|
|
<p>This corresponds to the ovf:Configuration element of the
|
||
|
|
ovf:DeploymentOptionSection in the specification. The
|
||
|
|
ovf:DeploymentOptionSection specifies a discrete set of intended resource
|
||
|
|
allocation configurations. This class represents one item from that set.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</div></blockquote>
|
||
|
|
<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>key</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The key of the deployment option, corresponding to the ovf:id
|
||
|
|
attribute in the OVF descriptor.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>label</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – A localizable label for the deployment option.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – A localizable description for the deployment option.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>default_choice</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – A <tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> flag indicates whether this deployment option is
|
||
|
|
the default choice.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute is optional in the result when
|
||
|
|
retrieving information about an OVF package. If None or false, it
|
||
|
|
is not the default.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.DeploymentOptionParams">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">DeploymentOptionParams</tt><big>(</big><em>deployment_options=None</em>, <em>selected_key=None</em>, <em>type=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#DeploymentOptionParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DeploymentOptionParams" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">DeploymentOptionParams</span></tt> class describes the possible deployment
|
||
|
|
options as well as the choice provided by the user.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><p>This information based on the ovf:DeploymentOptionSection.</p>
|
||
|
|
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</p>
|
||
|
|
</div></blockquote>
|
||
|
|
<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>deployment_options</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.DeploymentOption" title="com.vmware.vcenter.ovf_client.DeploymentOption"><tt class="xref py py-class docutils literal"><span class="pre">DeploymentOption</span></tt></a>) – <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of deployment options. This attribute corresponds to
|
||
|
|
the ovf:Configuration elements of the ovf:DeploymentOptionSection
|
||
|
|
in the specification. It is a discrete set of intended resource
|
||
|
|
allocation configurations from which one can be selected.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>selected_key</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The selected deployment option. Identifies the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.DeploymentOption" title="com.vmware.vcenter.ovf_client.DeploymentOption"><tt class="xref py py-class docutils literal"><span class="pre">DeploymentOption</span></tt></a> in the list in the <tt class="docutils literal"><span class="pre">deploymentOptions</span></tt>
|
||
|
|
attribute with a matching value in the <tt class="xref py py-attr docutils literal"><span class="pre">DeploymentOption.key</span></tt>
|
||
|
|
attribute.
|
||
|
|
This attribute is optional in the input parameters when deploying
|
||
|
|
an OVF package. If None the server will use the default deployment
|
||
|
|
configuration, usually it’s the first one in
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">DeploymentOptionParams.deployment_options</span></tt> <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt>.
|
||
|
|
This attribute is optional in the result when retrieving
|
||
|
|
information about an OVF package. The value will be set only if it
|
||
|
|
is specified with the optional ovf:default attribute.</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Unique identifier describing the type of the OVF parameters. The
|
||
|
|
value is the name of the OVF parameters class.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.DiskProvisioningType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">DiskProvisioningType</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#DiskProvisioningType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">DiskProvisioningType</span></tt> class defines the virtual disk provisioning
|
||
|
|
types that can be set for a disk on the target platform.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType" title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><tt class="xref py py-class docutils literal"><span class="pre">DiskProvisioningType</span></tt></a> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.DiskProvisioningType.eagerZeroedThick">
|
||
|
|
<tt class="descname">eagerZeroedThick</tt><em class="property"> = DiskProvisioningType(string='eagerZeroedThick')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType.eagerZeroedThick" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>An eager zeroed thick provisioned virtual disk has all space allocated and
|
||
|
|
wiped clean of any previous contents on the physical media at creation
|
||
|
|
time.</p>
|
||
|
|
<p>Disks specified as eager zeroed thick may take longer time to create than
|
||
|
|
disks specified with the other disk provisioning types.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.DiskProvisioningType.thick">
|
||
|
|
<tt class="descname">thick</tt><em class="property"> = DiskProvisioningType(string='thick')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType.thick" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>A thick provisioned virtual disk has all space allocated at creation time
|
||
|
|
and the space is zeroed on demand as the space is used.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.DiskProvisioningType.thin">
|
||
|
|
<tt class="descname">thin</tt><em class="property"> = DiskProvisioningType(string='thin')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType.thin" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>A thin provisioned virtual disk has space allocated and zeroed on demand as
|
||
|
|
the space is used.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ExportFlag">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">ExportFlag</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#ExportFlag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExportFlag" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ExportFlag</span></tt> class provides methods for retrieving information about
|
||
|
|
the export flags supported by the server. Export flags can be specified in
|
||
|
|
a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.CreateSpec</span></tt></a> to customize an OVF export.</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> (<a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt></a>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ExportFlag.Info">
|
||
|
|
<em class="property">class </em><tt class="descname">Info</tt><big>(</big><em>option=None</em>, <em>description=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#ExportFlag.Info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExportFlag.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ExportFlag.Info</span></tt> class describes an export flag supported by the
|
||
|
|
server.</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>option</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of the export flag that is supported by the server.</li>
|
||
|
|
<li><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>) – Localizable description of the export flag.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ExportFlag.list">
|
||
|
|
<tt class="descclassname">ExportFlag.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#ExportFlag.list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExportFlag.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns information about the supported export flags by the server.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>The supported flags are:</div></blockquote>
|
||
|
|
<dl class="docutils">
|
||
|
|
<dt>PRESERVE_MAC</dt>
|
||
|
|
<dd>Include MAC addresses for network adapters.</dd>
|
||
|
|
<dt>EXTRA_CONFIG</dt>
|
||
|
|
<dd><blockquote class="first">
|
||
|
|
<div>Include extra configuration in OVF export.</div></blockquote>
|
||
|
|
<p class="last">Future server versions might support additional flags.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<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">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExportFlag.list" title="com.vmware.vcenter.ovf_client.ExportFlag.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExportFlag.Info" title="com.vmware.vcenter.ovf_client.ExportFlag.Info"><tt class="xref py py-class docutils literal"><span class="pre">ExportFlag.Info</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExportFlag.list" title="com.vmware.vcenter.ovf_client.ExportFlag.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of supported export flags.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ExtraConfig">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">ExtraConfig</tt><big>(</big><em>key=None</em>, <em>value=None</em>, <em>virtual_system_id=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#ExtraConfig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExtraConfig" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ExtraConfig</span></tt> class contains the information about a vmw:ExtraConfig
|
||
|
|
element which can be used to specify configuration settings that are
|
||
|
|
transferred directly to the <tt class="docutils literal"><span class="pre">.vmx</span></tt> file. The behavior of the
|
||
|
|
vmw:ExtraConfig element is similar to the <tt class="docutils literal"><span class="pre">extraConfig</span></tt> property of the
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachineConfigSpec</span></tt> object in the VMware vSphere API. Thus, the
|
||
|
|
same restrictions apply, such as you cannot set values that could otherwise
|
||
|
|
be set with other properties in the <tt class="docutils literal"><span class="pre">VirtualMachineConfigSpec</span></tt> object.
|
||
|
|
See the VMware vSphere API reference for details on this.</p>
|
||
|
|
<p>vmw:ExtraConfig elements may occur as direct child elements of a
|
||
|
|
VirtualHardwareSection, or as child elements of individual virtual hardware
|
||
|
|
items.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</div></blockquote>
|
||
|
|
<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>key</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The key of the ExtraConfig element.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The value of the ExtraConfig element.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>virtual_system_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the virtual system containing the vmw:ExtraConfig
|
||
|
|
element.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ExtraConfigParams">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">ExtraConfigParams</tt><big>(</big><em>extra_configs=None</em>, <em>exclude_keys=None</em>, <em>include_keys=None</em>, <em>type=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#ExtraConfigParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExtraConfigParams" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ExtraConfigParams</span></tt> class contains the parameters with information
|
||
|
|
about the vmw:ExtraConfig elements in an OVF package.</p>
|
||
|
|
<p>vmw:ExtraConfig elements can be used to specify configuration settings that
|
||
|
|
are transferred directly to the <tt class="docutils literal"><span class="pre">.vmx</span></tt> file.</p>
|
||
|
|
<p>The behavior of the vmw:ExtraConfig element is similar to the
|
||
|
|
<tt class="docutils literal"><span class="pre">extraConfig</span></tt> property of the <tt class="docutils literal"><span class="pre">VirtualMachineConfigSpec</span></tt> object in the
|
||
|
|
VMware vSphere API. Thus, the same restrictions apply, such as you cannot
|
||
|
|
set values that could otherwise be set with other properties in the
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachineConfigSpec</span></tt> object. See the VMware vSphere API reference
|
||
|
|
for details on this.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</div></blockquote>
|
||
|
|
<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>extra_configs</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExtraConfig" title="com.vmware.vcenter.ovf_client.ExtraConfig"><tt class="xref py py-class docutils literal"><span class="pre">ExtraConfig</span></tt></a>) – <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of vmw:ExtraConfig elements in the OVF package.
|
||
|
|
This attribute is optional in the input parameters when deploying
|
||
|
|
an OVF package. If None there are no extra configuration elements
|
||
|
|
to use for this OVF package deployment. This attribute will always
|
||
|
|
be present in the result when retrieving information about an OVF
|
||
|
|
package. It will be an empty <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> if there are no extra
|
||
|
|
configuration elements in the OVF package.</li>
|
||
|
|
<li><strong>exclude_keys</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <p>Specifies which extra configuration items in the <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> in
|
||
|
|
the <tt class="docutils literal"><span class="pre">extraConfigs</span></tt> <tt class="docutils literal"><span class="pre">field</span></tt> should be ignored during deployment.</p>
|
||
|
|
<p>If set, the given keys for extra configurations will be ignored
|
||
|
|
during deployment. The key is defined in the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ExtraConfig.key</span></tt> attribute.
|
||
|
|
This attribute is optional in the input parameters when deploying
|
||
|
|
an OVF package. It is an error to set both this and
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ExtraConfigParams.include_keys</span></tt>. This attribute is optional
|
||
|
|
in the result when retrieving information about an OVF package. It
|
||
|
|
is an error to set both this and
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ExtraConfigParams.include_keys</span></tt>.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>include_keys</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <p>Specifies which extra configuration items in the <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> in
|
||
|
|
the <tt class="docutils literal"><span class="pre">extraConfigs</span></tt> <tt class="docutils literal"><span class="pre">field</span></tt> should be included during
|
||
|
|
deployment.</p>
|
||
|
|
<p>If set, all but the given keys for extra configurations will be
|
||
|
|
ignored during deployment. The key is defined in the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ExtraConfig.key</span></tt> attribute.
|
||
|
|
This attribute is optional in the input parameters when deploying
|
||
|
|
an OVF package. It is an error to set both this and
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ExtraConfigParams.exclude_keys</span></tt>. This attribute is optional
|
||
|
|
in the result when retrieving information about an OVF package. It
|
||
|
|
is an error to set both this and
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ExtraConfigParams.exclude_keys</span></tt>.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Unique identifier describing the type of the OVF parameters. The
|
||
|
|
value is the name of the OVF parameters class.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ImportFlag">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">ImportFlag</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#ImportFlag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ImportFlag" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ImportFlag</span></tt> class provides methods for retrieving information about
|
||
|
|
the import flags supported by the deployment platform. Import flags can be
|
||
|
|
specified in a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></tt></a> to customize
|
||
|
|
an OVF deployment.</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> (<a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt></a>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ImportFlag.Info">
|
||
|
|
<em class="property">class </em><tt class="descname">Info</tt><big>(</big><em>option=None</em>, <em>description=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#ImportFlag.Info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ImportFlag.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ImportFlag.Info</span></tt> class describes an import flag supported by the
|
||
|
|
deployment platform.</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>option</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of the import flag that is supported by the deployment
|
||
|
|
platform.</li>
|
||
|
|
<li><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>) – Localizable description of the import flag.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ImportFlag.list">
|
||
|
|
<tt class="descclassname">ImportFlag.</tt><tt class="descname">list</tt><big>(</big><em>rp</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#ImportFlag.list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ImportFlag.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns information about the import flags supported by the deployment
|
||
|
|
platform.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>The supported flags are:</div></blockquote>
|
||
|
|
<dl class="docutils">
|
||
|
|
<dt>LAX</dt>
|
||
|
|
<dd><blockquote class="first">
|
||
|
|
<div>Lax mode parsing of the OVF descriptor.</div></blockquote>
|
||
|
|
<p class="last">Future server versions might support additional flags.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>rp</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of resource pool target for retrieving the import
|
||
|
|
flag(s).
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">ResourcePool</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.ovf_client.ImportFlag.list" title="com.vmware.vcenter.ovf_client.ImportFlag.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ImportFlag.Info" title="com.vmware.vcenter.ovf_client.ImportFlag.Info"><tt class="xref py py-class docutils literal"><span class="pre">ImportFlag.Info</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ImportFlag.list" title="com.vmware.vcenter.ovf_client.ImportFlag.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of supported import flags.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
If the resource pool associated with <tt class="docutils literal"><span class="pre">rp</span></tt> does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">ResourcePool</span></tt> referenced by the parameter <tt class="docutils literal"><span class="pre">rp</span></tt>
|
||
|
|
requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">IpAllocationParams</tt><big>(</big><em>supported_allocation_scheme=None</em>, <em>supported_ip_allocation_policy=None</em>, <em>ip_allocation_policy=None</em>, <em>supported_ip_protocol=None</em>, <em>ip_protocol=None</em>, <em>type=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#IpAllocationParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">IpAllocationParams</span></tt> class specifies how IP addresses are allocated
|
||
|
|
to OVF properties. In particular, it informs the deployment platform
|
||
|
|
whether the guest supports IPv4, IPv6, or both. It also specifies whether
|
||
|
|
the IP addresses can be obtained through DHCP or through the properties
|
||
|
|
provided in the OVF environment.</p>
|
||
|
|
<p>Ovf Property elements are exposed to the guest software through the OVF
|
||
|
|
environment. Each Property element exposed in the OVF environment shall be
|
||
|
|
constructed from the value of the ovf:key attribute. A Property element
|
||
|
|
contains a key/value pair, it may optionally specify type qualifiers using
|
||
|
|
the ovf:qualifiers attribute with multiple qualifiers separated by commas.</p>
|
||
|
|
<p>The settings in <tt class="docutils literal"><span class="pre">IpAllocationParams</span></tt> class are global to a deployment.
|
||
|
|
Thus, if a virtual machine is part of a virtual appliance, then its
|
||
|
|
settings are ignored and the settings for the virtual appliance is used.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><p>This information is based on the vmw:IpAssignmentSection in OVF package.</p>
|
||
|
|
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</p>
|
||
|
|
</div></blockquote>
|
||
|
|
<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>supported_allocation_scheme</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme"><tt class="xref py py-class docutils literal"><span class="pre">IpAllocationParams.IpAllocationScheme</span></tt></a>) – Specifies the IP allocation schemes supported by the guest
|
||
|
|
software. This attribute defines the valid values for the IP
|
||
|
|
allocation policy. This setting is often configured by the virtual
|
||
|
|
appliance template author or OVF package author to reflect what the
|
||
|
|
guest software supports, and the IP allocation policy is configured
|
||
|
|
at deployment time. See
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">IpAllocationParams.ip_allocation_policy</span></tt>.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>supported_ip_allocation_policy</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"><tt class="xref py py-class docutils literal"><span class="pre">IpAllocationParams.IpAllocationPolicy</span></tt></a>) – Specifies the IP allocation policies supported. The set of valid
|
||
|
|
options for the policy is based on the capabilities of the virtual
|
||
|
|
appliance software, as specified by the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">IpAllocationParams.supported_allocation_scheme</span></tt> attribute.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>ip_allocation_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"><tt class="xref py py-class docutils literal"><span class="pre">IpAllocationParams.IpAllocationPolicy</span></tt></a>) – Specifies how IP allocation is done through an IP Pool. This is
|
||
|
|
typically specified by the deployer.
|
||
|
|
This attribute is optional in the input parameters when deploying
|
||
|
|
an OVF package. If None there is no IP allocation policy. This
|
||
|
|
attribute will always be present in the result when retrieving
|
||
|
|
information about an OVF package.</li>
|
||
|
|
<li><strong>supported_ip_protocol</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"><tt class="xref py py-class docutils literal"><span class="pre">IpAllocationParams.IpProtocol</span></tt></a>) – Specifies the IP protocols supported by the guest.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>ip_protocol</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"><tt class="xref py py-class docutils literal"><span class="pre">IpAllocationParams.IpProtocol</span></tt></a>) – Specifies the chosen IP protocol for this deployment. This must be
|
||
|
|
one of the IP protocols supported by the guest software. See
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">IpAllocationParams.supported_ip_protocol</span></tt>.
|
||
|
|
This attribute is optional in the input parameters when deploying
|
||
|
|
an OVF package. If None there is no IP protocol chosen. This
|
||
|
|
attribute will always be present in the result when retrieving
|
||
|
|
information about an OVF package.</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Unique identifier describing the type of the OVF parameters. The
|
||
|
|
value is the name of the OVF parameters class.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy">
|
||
|
|
<em class="property">class </em><tt class="descname">IpAllocationPolicy</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#IpAllocationParams.IpAllocationPolicy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">IpAllocationParams.IpAllocationPolicy</span></tt> class defines the possible IP
|
||
|
|
allocation policy for a deployment.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">IpAllocationPolicy</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.DHCP">
|
||
|
|
<tt class="descname">DHCP</tt><em class="property"> = IpAllocationPolicy(string='DHCP')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.DHCP" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Specifies that DHCP will be used to allocate IP addresses.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_IPPOOL">
|
||
|
|
<tt class="descname">STATIC_IPPOOL</tt><em class="property"> = IpAllocationPolicy(string='STATIC_IPPOOL')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_IPPOOL" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Specifies that IP addresses are allocated from the range managed by an IP
|
||
|
|
pool. The IP addresses are allocated at first power-on, and remain
|
||
|
|
allocated at power-off. This ensures that a virtual appliance gets a
|
||
|
|
consistent IP for its life-time.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_MANUAL">
|
||
|
|
<tt class="descname">STATIC_MANUAL</tt><em class="property"> = IpAllocationPolicy(string='STATIC_MANUAL')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_MANUAL" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Specifies that IP addresses are configured manually upon deployment, and
|
||
|
|
will be kept until reconfigured or the virtual appliance destroyed. This
|
||
|
|
ensures that a property gets a consistent IP for its lifetime.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.TRANSIENT_IPPOOL">
|
||
|
|
<tt class="descname">TRANSIENT_IPPOOL</tt><em class="property"> = IpAllocationPolicy(string='TRANSIENT_IPPOOL')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.TRANSIENT_IPPOOL" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Specifies that IP addresses are allocated from an IP pool. The IP addresses
|
||
|
|
are allocated when needed, typically at power-on, and deallocated during
|
||
|
|
power-off. There is no guarantee that a property will receive same IP
|
||
|
|
address when restarted.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme">
|
||
|
|
<em class="property">class </em><tt class="descclassname">IpAllocationParams.</tt><tt class="descname">IpAllocationScheme</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#IpAllocationParams.IpAllocationScheme"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">IpAllocationParams.IpAllocationScheme</span></tt> class defines the possible IP
|
||
|
|
allocation schemes that can be supported by the guest software.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">IpAllocationScheme</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.DHCP">
|
||
|
|
<tt class="descname">DHCP</tt><em class="property"> = IpAllocationScheme(string='DHCP')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.DHCP" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>It supports DHCP to acquire IP configuration.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.OVF_ENVIRONMENT">
|
||
|
|
<tt class="descname">OVF_ENVIRONMENT</tt><em class="property"> = IpAllocationScheme(string='OVF_ENVIRONMENT')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.OVF_ENVIRONMENT" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>It supports setting the IP configuration through the properties provided in
|
||
|
|
the OVF environment.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol">
|
||
|
|
<em class="property">class </em><tt class="descclassname">IpAllocationParams.</tt><tt class="descname">IpProtocol</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#IpAllocationParams.IpProtocol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">IpAllocationParams.IpProtocol</span></tt> class defines the IP protocols
|
||
|
|
supported by the guest software.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">IpProtocol</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV4">
|
||
|
|
<tt class="descname">IPV4</tt><em class="property"> = IpProtocol(string='IPV4')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV4" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>It supports the IPv4 protocol.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV6">
|
||
|
|
<tt class="descname">IPV6</tt><em class="property"> = IpProtocol(string='IPV6')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV6" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>It supports the IPv6 protocol.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">LibraryItem</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryItem</span></tt> class provides methods to deploy virtual machines and
|
||
|
|
virtual appliances from library items containing Open Virtualization Format
|
||
|
|
(OVF) packages in content library, as well as methods to create library
|
||
|
|
items in content library from virtual machines and virtual appliances.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>To deploy a virtual machine or a virtual appliance from a library item:</div></blockquote>
|
||
|
|
<ol class="arabic simple">
|
||
|
|
<li>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.DeploymentTarget</span></tt></a> to specify the target
|
||
|
|
deployment type and target deployment designation.</li>
|
||
|
|
<li>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></tt></a> to specify the
|
||
|
|
parameters for the target deployment.</li>
|
||
|
|
<li>Use the <tt class="docutils literal"><span class="pre">deploy</span></tt> method with the created target and parameter
|
||
|
|
specifications, along with the identifier of the specified source content
|
||
|
|
library item. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a>.</li>
|
||
|
|
</ol>
|
||
|
|
<p>To create a library item in content library from a virtual machine or
|
||
|
|
virtual appliance:</p>
|
||
|
|
<ol class="arabic simple">
|
||
|
|
<li>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity" title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.DeployableIdentity</span></tt></a> to specify the source
|
||
|
|
virtual machine or virtual appliance to be used as the OVF template source.</li>
|
||
|
|
<li>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.CreateTarget</span></tt></a> to specify the target library
|
||
|
|
and library item.</li>
|
||
|
|
<li>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.CreateSpec</span></tt></a> to specify the settings for the
|
||
|
|
OVF package to be created.</li>
|
||
|
|
<li>Use the <tt class="docutils literal"><span class="pre">create</span></tt> method with the created target and parameter
|
||
|
|
specifications, along with the specified source entity. See
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.create" title="com.vmware.vcenter.ovf_client.LibraryItem.create"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.create()</span></tt></a>.</li>
|
||
|
|
</ol>
|
||
|
|
<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> (<a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt></a>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.CreateResult">
|
||
|
|
<em class="property">class </em><tt class="descname">CreateResult</tt><big>(</big><em>succeeded=None</em>, <em>ovf_library_item_id=None</em>, <em>error=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.CreateResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateResult" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryItem.CreateResult</span></tt> class defines the result of the <tt class="docutils literal"><span class="pre">create</span></tt>
|
||
|
|
method. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.create" title="com.vmware.vcenter.ovf_client.LibraryItem.create"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.create()</span></tt></a>.</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>succeeded</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Whether the <tt class="docutils literal"><span class="pre">create</span></tt> method completed successfully.</li>
|
||
|
|
<li><strong>ovf_library_item_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Identifier of the created or updated library item.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>. When methods return a value of
|
||
|
|
this class as a return value, the attribute will be an identifier
|
||
|
|
for the resource type: <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.
|
||
|
|
If None, the <tt class="docutils literal"><span class="pre">create</span></tt> method failed and
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.CreateResult.error</span></tt> will describe the error(s)
|
||
|
|
that caused the failure.</li>
|
||
|
|
<li><strong>error</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo" title="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.ResultInfo</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Errors, warnings, and informational messages produced by the
|
||
|
|
<tt class="docutils literal"><span class="pre">create</span></tt> method.
|
||
|
|
If None, no errors, warnings, or informational messages were
|
||
|
|
reported by the <tt class="docutils literal"><span class="pre">create</span></tt> method.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">LibraryItem.</tt><tt class="descname">CreateSpec</tt><big>(</big><em>name=None</em>, <em>description=None</em>, <em>flags=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.CreateSpec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryItem.CreateSpec</span></tt> class defines the information used to create
|
||
|
|
or update a library item containing an OVF package.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Name to use in the OVF descriptor stored in the library item.
|
||
|
|
If None, the server will use source’s current name.</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Description to use in the OVF descriptor stored in the library
|
||
|
|
item.
|
||
|
|
If None, the server will use source’s current annotation.</li>
|
||
|
|
<li><strong>flags</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flags to use for OVF package creation. The supported flags can be
|
||
|
|
obtained using <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExportFlag.list" title="com.vmware.vcenter.ovf_client.ExportFlag.list"><tt class="xref py py-func docutils literal"><span class="pre">ExportFlag.list()</span></tt></a>.
|
||
|
|
If None, no flags will be used.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget">
|
||
|
|
<em class="property">class </em><tt class="descclassname">LibraryItem.</tt><tt class="descname">CreateTarget</tt><big>(</big><em>library_id=None</em>, <em>library_item_id=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.CreateTarget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryItem.CreateTarget</span></tt> class specifies the target library item
|
||
|
|
when capturing a virtual machine or virtual appliance as an OVF package in
|
||
|
|
a library item in a content library. The target can be an existing library
|
||
|
|
item, which will be updated, creating a new version, or it can be a newly
|
||
|
|
created library item in a specified library. See
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.create" title="com.vmware.vcenter.ovf_client.LibraryItem.create"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.create()</span></tt></a>.</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>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Identifier of the library in which a new library item should be
|
||
|
|
created. This attribute is not used if the <tt class="docutils literal"><span class="pre">libraryItemId</span></tt>
|
||
|
|
attribute is specified.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>. When methods return a value of this
|
||
|
|
class as a return value, the attribute will be an identifier for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.
|
||
|
|
If None, the <tt class="docutils literal"><span class="pre">libraryItemId</span></tt> attribute must be specified.</li>
|
||
|
|
<li><strong>library_item_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Identifier of the library item that should be should be updated.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>. When methods return a value of
|
||
|
|
this class as a return value, the attribute will be an identifier
|
||
|
|
for the resource type: <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.
|
||
|
|
If None, a new library item will be created. The <tt class="docutils literal"><span class="pre">libraryId</span></tt>
|
||
|
|
attribute must be specified if this attribute is None.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.DEPLOYABLE">
|
||
|
|
<tt class="descclassname">LibraryItem.</tt><tt class="descname">DEPLOYABLE</tt><em class="property"> = ['VirtualMachine', 'VirtualApp']</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.DEPLOYABLE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The types of resources that can be created by deploying an OVF package and can
|
||
|
|
be captured to create a library item using the <tt class="docutils literal"><span class="pre">LibraryItem</span></tt> class.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity">
|
||
|
|
<em class="property">class </em><tt class="descclassname">LibraryItem.</tt><tt class="descname">DeployableIdentity</tt><big>(</big><em>type=None</em>, <em>id=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.DeployableIdentity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryItem.DeployableIdentity</span></tt> class describes the resource created
|
||
|
|
by a deployment, or the source resource from which library item can be
|
||
|
|
created, by specifying its resource type and resource identifier.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Type of the deployable resource.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be one of <tt class="docutils literal"><span class="pre">VirtualMachine</span></tt> or <tt class="docutils literal"><span class="pre">VirtualApp</span></tt>. When
|
||
|
|
methods return a value of this class as a return value, the
|
||
|
|
attribute will be one of <tt class="docutils literal"><span class="pre">VirtualMachine</span></tt> or <tt class="docutils literal"><span class="pre">VirtualApp</span></tt>.</li>
|
||
|
|
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the deployable resource.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute <tt class="docutils literal"><span class="pre">type</span></tt> must contain the actual resource type. When
|
||
|
|
methods return a value of this class as a return value, the
|
||
|
|
attribute <tt class="docutils literal"><span class="pre">type</span></tt> will contain the actual resource type.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentResult">
|
||
|
|
<em class="property">class </em><tt class="descclassname">LibraryItem.</tt><tt class="descname">DeploymentResult</tt><big>(</big><em>succeeded=None</em>, <em>resource_id=None</em>, <em>error=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.DeploymentResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentResult" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryItem.DeploymentResult</span></tt> class defines the result of the
|
||
|
|
<tt class="docutils literal"><span class="pre">deploy</span></tt> method. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a>.</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>succeeded</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Whether the <tt class="docutils literal"><span class="pre">deploy</span></tt> method completed successfully.</li>
|
||
|
|
<li><strong>resource_id</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity" title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.DeployableIdentity</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Identifier of the deployed resource entity.
|
||
|
|
If None, the <tt class="docutils literal"><span class="pre">deploy</span></tt> method failed and
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.DeploymentResult.error</span></tt> will describe the
|
||
|
|
error(s) that caused the failure.</li>
|
||
|
|
<li><strong>error</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo" title="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.ResultInfo</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Errors, warnings, and informational messages produced by the
|
||
|
|
<tt class="docutils literal"><span class="pre">deploy</span></tt> method.
|
||
|
|
If None, no errors, warnings, or informational messages were
|
||
|
|
reported by the <tt class="docutils literal"><span class="pre">deploy</span></tt> method.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget">
|
||
|
|
<em class="property">class </em><tt class="descclassname">LibraryItem.</tt><tt class="descname">DeploymentTarget</tt><big>(</big><em>resource_pool_id=None</em>, <em>host_id=None</em>, <em>folder_id=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.DeploymentTarget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryItem.DeploymentTarget</span></tt> class describes the location (target)
|
||
|
|
where a virtual machine or virtual appliance should be deployed. It is used
|
||
|
|
in the <tt class="docutils literal"><span class="pre">deploy</span></tt> and <tt class="docutils literal"><span class="pre">filter</span></tt> methods. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a>
|
||
|
|
and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</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>resource_pool_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the resource pool to which the virtual machine or
|
||
|
|
virtual appliance should be attached.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">ResourcePool</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will be an identifier for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">ResourcePool</span></tt>.</li>
|
||
|
|
<li><strong>host_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Identifier of the target host on which the virtual machine or
|
||
|
|
virtual appliance will run. The target host must be a member of the
|
||
|
|
cluster that contains the resource pool identified by
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></tt>.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">HostSystem</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will be an identifier for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">HostSystem</span></tt>.
|
||
|
|
If None, the server will automatically select a target host from
|
||
|
|
the resource pool if
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></tt> is a
|
||
|
|
stand-alone host or a cluster with Distributed Resource Scheduling
|
||
|
|
(DRS) enabled.</li>
|
||
|
|
<li><strong>folder_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Identifier of the vCenter folder that should contain the virtual
|
||
|
|
machine or virtual appliance. The folder must be virtual machine
|
||
|
|
folder.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type: <tt class="docutils literal"><span class="pre">Folder</span></tt>.
|
||
|
|
When methods return a value of this class as a return value, the
|
||
|
|
attribute will be an identifier for the resource type: <tt class="docutils literal"><span class="pre">Folder</span></tt>.
|
||
|
|
If None, the server will choose the deployment folder.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.OvfSummary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">LibraryItem.</tt><tt class="descname">OvfSummary</tt><big>(</big><em>name=None</em>, <em>annotation=None</em>, <em>eulas=None</em>, <em>networks=None</em>, <em>storage_groups=None</em>, <em>additional_params=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.OvfSummary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.OvfSummary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryItem.OvfSummary</span></tt> class defines the result of the <tt class="docutils literal"><span class="pre">filter</span></tt>
|
||
|
|
method. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>. The attributes in the class
|
||
|
|
describe parameterizable information in the OVF descriptor, with respect to
|
||
|
|
a deployment target, for the <tt class="docutils literal"><span class="pre">deploy</span></tt> method. See
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a>.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Default name for the virtual machine or virtual appliance.
|
||
|
|
If None, the OVF descriptor did not specify a name.</li>
|
||
|
|
<li><strong>annotation</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Default annotation for the virtual machine or virtual appliance.
|
||
|
|
If None, the OVF descriptor did not specify an annotation.</li>
|
||
|
|
<li><strong>eulas</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of End User License Agreements specified in the OVF
|
||
|
|
descriptor. All end user license agreements must be accepted in
|
||
|
|
order for the <tt class="docutils literal"><span class="pre">deploy</span></tt> method to succeed. See
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.accept_all_eula</span></tt>.</li>
|
||
|
|
<li><strong>networks</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of section identifiers for sections of type
|
||
|
|
ovf:NetworkSection in the OVF descriptor. These identifiers can be
|
||
|
|
used as keys in
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.network_mappings</span></tt>.
|
||
|
|
If None, the OVF descriptor did not specify any networks.</li>
|
||
|
|
<li><strong>storage_groups</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of section identifiers for sections of type
|
||
|
|
vmw:StorageGroupSection in the OVF descriptor. These identifiers
|
||
|
|
can be used as keys in
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.storage_mappings</span></tt>.
|
||
|
|
If None, the OVF descriptor did not specify any storage groups.</li>
|
||
|
|
<li><strong>additional_params</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.struct.VapiStruct</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – List of additional OVF parameters which can be specified for the
|
||
|
|
deployment target. These OVF parameters can be inspected,
|
||
|
|
optionally modified, and used as values in
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.additional_parameters</span></tt>
|
||
|
|
for the <tt class="docutils literal"><span class="pre">deploy</span></tt> method.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain all the attributes defined in
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfParams" title="com.vmware.vcenter.ovf_client.OvfParams"><tt class="xref py py-class docutils literal"><span class="pre">OvfParams</span></tt></a>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will contain all the attributes defined
|
||
|
|
in <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfParams" title="com.vmware.vcenter.ovf_client.OvfParams"><tt class="xref py py-class docutils literal"><span class="pre">OvfParams</span></tt></a>.
|
||
|
|
If None, the OVF descriptor does not require addtional parameters
|
||
|
|
or does not have additional parameters suitable for the deployment
|
||
|
|
target.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">LibraryItem.</tt><tt class="descname">ResourcePoolDeploymentSpec</tt><big>(</big><em>name=None</em>, <em>annotation=None</em>, <em>accept_all_eula=None</em>, <em>network_mappings=None</em>, <em>storage_mappings=None</em>, <em>storage_provisioning=None</em>, <em>storage_profile_id=None</em>, <em>locale=None</em>, <em>flags=None</em>, <em>additional_parameters=None</em>, <em>default_datastore_id=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.ResourcePoolDeploymentSpec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></tt> class defines the deployment
|
||
|
|
parameters that can be specified for the <tt class="docutils literal"><span class="pre">deploy</span></tt> method where the
|
||
|
|
deployment target is a resource pool. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a>.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Name assigned to the deployed target virtual machine or virtual
|
||
|
|
appliance.
|
||
|
|
If None, the server will use the name from the OVF package.</li>
|
||
|
|
<li><strong>annotation</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Annotation assigned to the deployed target virtual machine or
|
||
|
|
virtual appliance.
|
||
|
|
If None, the server will use the annotation from the OVF package.</li>
|
||
|
|
<li><strong>accept_all_eula</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Whether to accept all End User License Agreements. See
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.OvfSummary.eulas</span></tt>.</li>
|
||
|
|
<li><strong>network_mappings</strong> ((<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> and <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) or <tt class="docutils literal"><span class="pre">None</span></tt>) – Specification of the target network to use for sections of type
|
||
|
|
ovf:NetworkSection in the OVF descriptor. The key in the
|
||
|
|
<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> is the section identifier of the ovf:NetworkSection
|
||
|
|
section in the OVF descriptor and the value is the target network
|
||
|
|
to be used for deployment.
|
||
|
|
When clients pass a value of this class as a parameter, the value
|
||
|
|
in the attribute <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> must be an identifier for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">Network</span></tt>. When methods return a value of this
|
||
|
|
class as a return value, the value in the attribute <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>
|
||
|
|
will be an identifier for the resource type: <tt class="docutils literal"><span class="pre">Network</span></tt>.
|
||
|
|
If None, the server will choose a network mapping.</li>
|
||
|
|
<li><strong>storage_mappings</strong> ((<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.StorageGroupMapping</span></tt></a>) or <tt class="docutils literal"><span class="pre">None</span></tt>) – Specification of the target storage to use for sections of type
|
||
|
|
vmw:StorageGroupSection in the OVF descriptor. The key in the
|
||
|
|
<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> is the section identifier of the
|
||
|
|
ovf:StorageGroupSection section in the OVF descriptor and the value
|
||
|
|
is the target storage specification to be used for deployment. See
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.StorageGroupMapping</span></tt></a>.
|
||
|
|
If None, the server will choose a storage mapping.</li>
|
||
|
|
<li><strong>storage_provisioning</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType" title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><tt class="xref py py-class docutils literal"><span class="pre">DiskProvisioningType</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Default storage provisioning type to use for all sections of type
|
||
|
|
vmw:StorageSection in the OVF descriptor.
|
||
|
|
If None, the server will choose the provisioning type.</li>
|
||
|
|
<li><strong>storage_profile_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Default storage profile to use for all sections of type
|
||
|
|
vmw:StorageSection in the OVF descriptor.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">StorageProfile</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will be an identifier for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">StorageProfile</span></tt>.
|
||
|
|
If None, the server will choose the default profile.</li>
|
||
|
|
<li><strong>locale</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The locale to use for parsing the OVF descriptor.
|
||
|
|
If None, the server locale will be used.</li>
|
||
|
|
<li><strong>flags</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flags to be use for deployment. The supported flag values can be
|
||
|
|
obtained using <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ImportFlag.list" title="com.vmware.vcenter.ovf_client.ImportFlag.list"><tt class="xref py py-func docutils literal"><span class="pre">ImportFlag.list()</span></tt></a>.
|
||
|
|
If None, no flags will be used.</li>
|
||
|
|
<li><strong>additional_parameters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.struct.VapiStruct</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Additional OVF parameters that may be needed for the deployment.
|
||
|
|
Additional OVF parameters may be required by the OVF descriptor of
|
||
|
|
the OVF package in the library item. Examples of OVF parameters
|
||
|
|
that can be specified through this attribute include, but are not
|
||
|
|
limited to:</p>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#com.vmware.vcenter.ovf_client.DeploymentOptionParams" title="com.vmware.vcenter.ovf_client.DeploymentOptionParams"><tt class="xref py py-class docutils literal"><span class="pre">DeploymentOptionParams</span></tt></a></li>
|
||
|
|
<li><a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExtraConfigParams" title="com.vmware.vcenter.ovf_client.ExtraConfigParams"><tt class="xref py py-class docutils literal"><span class="pre">ExtraConfigParams</span></tt></a></li>
|
||
|
|
<li><a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams" title="com.vmware.vcenter.ovf_client.IpAllocationParams"><tt class="xref py py-class docutils literal"><span class="pre">IpAllocationParams</span></tt></a></li>
|
||
|
|
<li><a class="reference internal" href="#com.vmware.vcenter.ovf_client.PropertyParams" title="com.vmware.vcenter.ovf_client.PropertyParams"><tt class="xref py py-class docutils literal"><span class="pre">PropertyParams</span></tt></a></li>
|
||
|
|
<li><a class="reference internal" href="#com.vmware.vcenter.ovf_client.ScaleOutParams" title="com.vmware.vcenter.ovf_client.ScaleOutParams"><tt class="xref py py-class docutils literal"><span class="pre">ScaleOutParams</span></tt></a></li>
|
||
|
|
<li><a class="reference internal" href="#com.vmware.vcenter.ovf_client.VcenterExtensionParams" title="com.vmware.vcenter.ovf_client.VcenterExtensionParams"><tt class="xref py py-class docutils literal"><span class="pre">VcenterExtensionParams</span></tt></a></li>
|
||
|
|
</ul>
|
||
|
|
<p>When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain all the attributes defined in
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfParams" title="com.vmware.vcenter.ovf_client.OvfParams"><tt class="xref py py-class docutils literal"><span class="pre">OvfParams</span></tt></a>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will contain all the attributes defined
|
||
|
|
in <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfParams" title="com.vmware.vcenter.ovf_client.OvfParams"><tt class="xref py py-class docutils literal"><span class="pre">OvfParams</span></tt></a>.
|
||
|
|
If None, the server will choose default settings for all parameters
|
||
|
|
necessary for the <tt class="docutils literal"><span class="pre">deploy</span></tt> method. See
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a>.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>default_datastore_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Default datastore to use for all sections of type
|
||
|
|
vmw:StorageSection in the OVF descriptor.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datastore</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will be an identifier for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">Datastore</span></tt>.
|
||
|
|
If None, the server will choose the default datastore.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo">
|
||
|
|
<em class="property">class </em><tt class="descclassname">LibraryItem.</tt><tt class="descname">ResultInfo</tt><big>(</big><em>errors=None</em>, <em>warnings=None</em>, <em>information=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.ResultInfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryItem.ResultInfo</span></tt> class defines the information returned along
|
||
|
|
with the result of a <tt class="docutils literal"><span class="pre">create</span></tt> or <tt class="docutils literal"><span class="pre">deploy</span></tt> method to describe errors,
|
||
|
|
warnings, and informational messages produced by the server.</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>errors</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfError" title="com.vmware.vcenter.ovf_client.OvfError"><tt class="xref py py-class docutils literal"><span class="pre">OvfError</span></tt></a>) – List of errors. Errors would have prevented the <tt class="docutils literal"><span class="pre">create</span></tt> or
|
||
|
|
<tt class="docutils literal"><span class="pre">deploy</span></tt> method from completing successfully.</li>
|
||
|
|
<li><strong>warnings</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfWarning" title="com.vmware.vcenter.ovf_client.OvfWarning"><tt class="xref py py-class docutils literal"><span class="pre">OvfWarning</span></tt></a>) – List of warnings. Warnings would not have prevented the <tt class="docutils literal"><span class="pre">create</span></tt>
|
||
|
|
or <tt class="docutils literal"><span class="pre">deploy</span></tt> method from completing successfully. But there might
|
||
|
|
be issues that warrant attention.</li>
|
||
|
|
<li><strong>information</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfInfo" title="com.vmware.vcenter.ovf_client.OvfInfo"><tt class="xref py py-class docutils literal"><span class="pre">OvfInfo</span></tt></a>) – List of information messages. For example, a non-required parameter
|
||
|
|
was ignored.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping">
|
||
|
|
<em class="property">class </em><tt class="descclassname">LibraryItem.</tt><tt class="descname">StorageGroupMapping</tt><big>(</big><em>type=None</em>, <em>datastore_id=None</em>, <em>storage_profile_id=None</em>, <em>provisioning=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.StorageGroupMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryItem.StorageGroupMapping</span></tt> class defines the storage
|
||
|
|
deployment target and storage provisioning type for a section of type
|
||
|
|
vmw:StorageGroupSection in the OVF descriptor.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.StorageGroupMapping.Type</span></tt></a>) – Type of storage deployment target to use for the
|
||
|
|
vmw:StorageGroupSection section. The specified value must be
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE"><tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.StorageGroupMapping.Type.DATASTORE</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE"><tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE</span></tt></a>.</li>
|
||
|
|
<li><strong>datastore_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Target datastore to be used for the storage group.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datastore</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will be an identifier for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">Datastore</span></tt>.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE"><tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.StorageGroupMapping.Type.DATASTORE</span></tt></a>.</li>
|
||
|
|
<li><strong>storage_profile_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Target storage profile to be used for the storage group.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">StorageProfile</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will be an identifier for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">StorageProfile</span></tt>.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE"><tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE</span></tt></a>.</li>
|
||
|
|
<li><strong>provisioning</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType" title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><tt class="xref py py-class docutils literal"><span class="pre">DiskProvisioningType</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Target provisioning type to use for the storage group.
|
||
|
|
If None,
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.storage_provisioning</span></tt>
|
||
|
|
will be used.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type">
|
||
|
|
<em class="property">class </em><tt class="descname">Type</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.StorageGroupMapping.Type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryItem.StorageGroupMapping.Type</span></tt> class defines the supported
|
||
|
|
types of storage targets for sections of type vmw:StroageGroupSection in
|
||
|
|
the OVF descriptor.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">Type</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE">
|
||
|
|
<tt class="descname">DATASTORE</tt><em class="property"> = Type(string='DATASTORE')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Storage deployment target is a datastore.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE">
|
||
|
|
<tt class="descname">STORAGE_PROFILE</tt><em class="property"> = Type(string='STORAGE_PROFILE')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Storage deployment target is a storage profile.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.create">
|
||
|
|
<tt class="descclassname">LibraryItem.</tt><tt class="descname">create</tt><big>(</big><em>source</em>, <em>target</em>, <em>create_spec</em>, <em>client_token=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.create" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Creates a library item in content library from a virtual machine or
|
||
|
|
virtual appliance.</p>
|
||
|
|
<p>This method creates a library item in content library whose content is
|
||
|
|
an OVF package derived from a source virtual machine or virtual
|
||
|
|
appliance, using the supplied create specification. The OVF package may
|
||
|
|
be stored as in a newly created library item or in an in an existing
|
||
|
|
library item. For an existing library item whose content is updated by
|
||
|
|
this method, the original content is overwritten.</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>client_token</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Client-generated token used to retry a request if the client fails
|
||
|
|
to get a response from the server. If the original request
|
||
|
|
succeeded, the result of that request will be returned, otherwise
|
||
|
|
the operation will be retried.
|
||
|
|
If None, the server will create a token.</li>
|
||
|
|
<li><strong>source</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity" title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.DeployableIdentity</span></tt></a>) – Identifier of the virtual machine or virtual appliance to use as
|
||
|
|
the source.</li>
|
||
|
|
<li><strong>target</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.CreateTarget</span></tt></a>) – Specification of the target content library and library item.</li>
|
||
|
|
<li><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.CreateSpec</span></tt></a>) – Information used to create the OVF package from the source virtual
|
||
|
|
machine or virtual appliance.</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.ovf_client.LibraryItem.CreateResult" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateResult"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.CreateResult</span></tt></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 success or failure of the method, along with
|
||
|
|
the details of the result or failure.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt></a>
|
||
|
|
if <tt class="docutils literal"><span class="pre">create_spec</span></tt> contains invalid arguments.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt></a>
|
||
|
|
if <tt class="docutils literal"><span class="pre">source</span></tt> describes an unexpected resource type.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
if the virtual machine or virtual appliance specified by <tt class="docutils literal"><span class="pre">source</span></tt>
|
||
|
|
does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
if the library or library item specified by <tt class="docutils literal"><span class="pre">target</span></tt> does not
|
||
|
|
exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt></a>
|
||
|
|
if the operation cannot be performed because of the specified
|
||
|
|
virtual machine or virtual appliance’s current state. For example,
|
||
|
|
if the virtual machine configuration information is not available,
|
||
|
|
or if the virtual appliance is running.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt></a>
|
||
|
|
if there was an error accessing a file from the source virtual
|
||
|
|
machine or virtual appliance.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt></a>
|
||
|
|
if the specified virtual machine or virtual appliance is busy.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The attribute <tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.DeployableIdentity.id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">VApp.Export</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
attribute <tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.CreateTarget.library_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.AddLibraryItem</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the attribute <tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.CreateTarget.library_item_id</span></tt>
|
||
|
|
requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.deploy">
|
||
|
|
<tt class="descclassname">LibraryItem.</tt><tt class="descname">deploy</tt><big>(</big><em>ovf_library_item_id</em>, <em>target</em>, <em>deployment_spec</em>, <em>client_token=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Deploys an OVF package stored in content library to a newly created
|
||
|
|
virtual machine or virtual appliance.</p>
|
||
|
|
<p>This method deploys an OVF package which is stored in the library item
|
||
|
|
specified by <tt class="docutils literal"><span class="pre">ovf_library_item_id</span></tt>. It uses the deployment
|
||
|
|
specification in <tt class="docutils literal"><span class="pre">deployment_spec</span></tt> to deploy the OVF package to the
|
||
|
|
location specified by <tt class="docutils literal"><span class="pre">target</span></tt>.</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>client_token</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Client-generated token used to retry a request if the client fails
|
||
|
|
to get a response from the server. If the original request
|
||
|
|
succeeded, the result of that request will be returned, otherwise
|
||
|
|
the operation will be retried.
|
||
|
|
If None, the server will create a token.</li>
|
||
|
|
<li><strong>ovf_library_item_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the content library item containing the OVF package
|
||
|
|
to be deployed.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</li>
|
||
|
|
<li><strong>target</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.DeploymentTarget</span></tt></a>) – Specification of the deployment target.</li>
|
||
|
|
<li><strong>deployment_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></tt></a>) – Specification of how the OVF package should be deployed to the
|
||
|
|
target.</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.ovf_client.LibraryItem.DeploymentResult" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentResult"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.DeploymentResult</span></tt></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 success or failure of the method, along with
|
||
|
|
the details of the result or failure.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt></a>
|
||
|
|
if <tt class="docutils literal"><span class="pre">target</span></tt> contains invalid arguments.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt></a>
|
||
|
|
if <tt class="docutils literal"><span class="pre">deployment_spec</span></tt> contains invalid arguments or has attributes
|
||
|
|
that are inconsistent with <tt class="docutils literal"><span class="pre">target</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
if the library item specified by <tt class="docutils literal"><span class="pre">ovf_library_item_id</span></tt> does not
|
||
|
|
exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
if any resource specified by a attribute of the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.DeploymentTarget</span></tt></a> class, specified by
|
||
|
|
<tt class="docutils literal"><span class="pre">target</span></tt>, does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt></a>
|
||
|
|
if there was an error accessing the OVF package stored in the
|
||
|
|
library item specified by <tt class="docutils literal"><span class="pre">ovf_library_item_id</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><dl class="first docutils">
|
||
|
|
<dt><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a> </dt>
|
||
|
|
<dd><p class="first last">if you do not have all of the privileges described as follows :</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>Method execution requires VirtualMachine.Config.AddNewDisk if the
|
||
|
|
OVF descriptor has a disk drive (type 17) section.</li>
|
||
|
|
<li>Method execution requires VirtualMachine.Config.AdvancedConfig if
|
||
|
|
the OVF descriptor has an ExtraConfig section.</li>
|
||
|
|
<li>Method execution requires Extension.Register for specified
|
||
|
|
resource group if the OVF descriptor has a vServiceDependency
|
||
|
|
section.</li>
|
||
|
|
<li>Method execution requires Network.Assign for target network if
|
||
|
|
specified.</li>
|
||
|
|
<li>Method execution requires Datastore.AllocateSpace for target
|
||
|
|
datastore if specified.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the parameter <tt class="docutils literal"><span class="pre">ovf_library_item_id</span></tt> requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">HostSystem</span></tt> referenced by the attribute
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.DeploymentTarget.host_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">Network</span></tt> referenced by the <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> value of
|
||
|
|
attribute
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.network_mappings</span></tt>
|
||
|
|
requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">StorageProfile</span></tt> referenced by the attribute
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.storage_profile_id</span></tt>
|
||
|
|
requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">Datastore</span></tt> referenced by the attribute
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.default_datastore_id</span></tt>
|
||
|
|
requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">ResourcePool</span></tt> referenced by the attribute
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">VApp.Import</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">Folder</span></tt> referenced by the attribute
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.DeploymentTarget.folder_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">VApp.Import</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.filter">
|
||
|
|
<tt class="descclassname">LibraryItem.</tt><tt class="descname">filter</tt><big>(</big><em>ovf_library_item_id</em>, <em>target</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#LibraryItem.filter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Queries an OVF package stored in content library to retrieve
|
||
|
|
information to use when deploying the package. See
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a>.</p>
|
||
|
|
<p>This method retrieves information from the descriptor of the OVF
|
||
|
|
package stored in the library item specified by
|
||
|
|
<tt class="docutils literal"><span class="pre">ovf_library_item_id</span></tt>. The information returned by the method can be
|
||
|
|
used to populate the deployment specification (see
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></tt></a> when deploying the OVF
|
||
|
|
package to the deployment target specified by <tt class="docutils literal"><span class="pre">target</span></tt>.</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>ovf_library_item_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the content library item containing the OVF package
|
||
|
|
to query.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</li>
|
||
|
|
<li><strong>target</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.DeploymentTarget</span></tt></a>) – Specification of the deployment target.</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.ovf_client.LibraryItem.OvfSummary" title="com.vmware.vcenter.ovf_client.LibraryItem.OvfSummary"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.OvfSummary</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Information that can be used to populate the deployment
|
||
|
|
specification (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></tt></a>)
|
||
|
|
when deploying the OVF package to the deployment target specified
|
||
|
|
by <tt class="docutils literal"><span class="pre">target</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt></a>
|
||
|
|
if <tt class="docutils literal"><span class="pre">target</span></tt> contains invalid arguments.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
if the library item specified by <tt class="docutils literal"><span class="pre">ovf_library_item_id</span></tt> does not
|
||
|
|
exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
if any resource specified by a attribute of the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><tt class="xref py py-class docutils literal"><span class="pre">LibraryItem.DeploymentTarget</span></tt></a> class, specified by
|
||
|
|
<tt class="docutils literal"><span class="pre">target</span></tt>, does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt></a>
|
||
|
|
if there was an error accessing the OVF package at the specified
|
||
|
|
<tt class="docutils literal"><span class="pre">ovf_library_item_id</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the parameter <tt class="docutils literal"><span class="pre">ovf_library_item_id</span></tt> requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">ResourcePool</span></tt> referenced by the attribute
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">HostSystem</span></tt> referenced by the attribute
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.DeploymentTarget.host_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">Folder</span></tt> referenced by the attribute
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryItem.DeploymentTarget.folder_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.OvfError">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">OvfError</tt><big>(</big><em>category=None</em>, <em>issues=None</em>, <em>name=None</em>, <em>value=None</em>, <em>message=None</em>, <em>error=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#OvfError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfError" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">OvfError</span></tt> class describes an error related to accessing, validating,
|
||
|
|
deploying, or exporting an OVF package.</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>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="com.vmware.vcenter.ovf_client.OvfMessage.Category"><tt class="xref py py-class docutils literal"><span class="pre">OvfMessage.Category</span></tt></a>) – The message category.</li>
|
||
|
|
<li><strong>issues</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><tt class="xref py py-class docutils literal"><span class="pre">ParseIssue</span></tt></a>) – <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of parse issues (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><tt class="xref py py-class docutils literal"><span class="pre">ParseIssue</span></tt></a>).
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.VALIDATION</span></tt></a>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of input parameter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.INPUT</span></tt></a>.</li>
|
||
|
|
<li><strong>value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The value of input parameter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.INPUT</span></tt></a>.</li>
|
||
|
|
<li><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>) – A localizable message.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.INPUT</span></tt></a>.</li>
|
||
|
|
<li><strong>error</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.struct.VapiStruct</span></tt>) – Represents a server
|
||
|
|
<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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain all the attributes defined in
|
||
|
|
<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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>. When methods
|
||
|
|
return a value of this class as a return value, the attribute will
|
||
|
|
contain all the attributes defined in
|
||
|
|
<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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.SERVER</span></tt></a>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.OvfInfo">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">OvfInfo</tt><big>(</big><em>messages=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#OvfInfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">OvfInfo</span></tt> class contains informational messages related to accessing,
|
||
|
|
validating, deploying, or exporting an OVF package.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>messages</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>) – A <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of localizable messages (see
|
||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>).</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.OvfMessage">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">OvfMessage</tt><big>(</big><em>category=None</em>, <em>issues=None</em>, <em>name=None</em>, <em>value=None</em>, <em>message=None</em>, <em>error=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#OvfMessage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">OvfMessage</span></tt> class describes a base OVF handling error message
|
||
|
|
related to accessing, validating, deploying, or exporting an OVF package.</p>
|
||
|
|
<p>These messages fall into different categories defined in
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="com.vmware.vcenter.ovf_client.OvfMessage.Category"><tt class="xref py py-class docutils literal"><span class="pre">OvfMessage.Category</span></tt></a>:</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>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="com.vmware.vcenter.ovf_client.OvfMessage.Category"><tt class="xref py py-class docutils literal"><span class="pre">OvfMessage.Category</span></tt></a>) – The message category.</li>
|
||
|
|
<li><strong>issues</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><tt class="xref py py-class docutils literal"><span class="pre">ParseIssue</span></tt></a>) – <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of parse issues (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><tt class="xref py py-class docutils literal"><span class="pre">ParseIssue</span></tt></a>).
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.VALIDATION</span></tt></a>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of input parameter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.INPUT</span></tt></a>.</li>
|
||
|
|
<li><strong>value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The value of input parameter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.INPUT</span></tt></a>.</li>
|
||
|
|
<li><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>) – A localizable message.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.INPUT</span></tt></a>.</li>
|
||
|
|
<li><strong>error</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.struct.VapiStruct</span></tt>) – Represents a server
|
||
|
|
<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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain all the attributes defined in
|
||
|
|
<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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>. When methods
|
||
|
|
return a value of this class as a return value, the attribute will
|
||
|
|
contain all the attributes defined in
|
||
|
|
<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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.SERVER</span></tt></a>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.OvfMessage.Category">
|
||
|
|
<em class="property">class </em><tt class="descname">Category</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#OvfMessage.Category"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">OvfMessage.Category</span></tt> class defines the categories of messages (see
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage" title="com.vmware.vcenter.ovf_client.OvfMessage"><tt class="xref py py-class docutils literal"><span class="pre">OvfMessage</span></tt></a>).</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">Category</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT">
|
||
|
|
<tt class="descname">INPUT</tt><em class="property"> = Category(string='INPUT')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The user provided input parameters are invalid.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER">
|
||
|
|
<tt class="descname">SERVER</tt><em class="property"> = Category(string='SERVER')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Server error.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION">
|
||
|
|
<tt class="descname">VALIDATION</tt><em class="property"> = Category(string='VALIDATION')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The OVF descriptor is invalid, for example, syntax errors or schema errors.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.OvfParams">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">OvfParams</tt><big>(</big><em>type=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#OvfParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfParams" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">OvfParams</span></tt> class defines the common attributes for all OVF
|
||
|
|
deployment parameters. OVF parameters serve several purposes:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>Describe information about a given OVF package.</li>
|
||
|
|
<li>Describe default deployment configuration.</li>
|
||
|
|
<li>Describe possible deployment values based on the deployment environment.</li>
|
||
|
|
<li>Provide deployment-specific configuration.</li>
|
||
|
|
</ul>
|
||
|
|
<p>Each OVF parameters class specifies a particular configurable aspect of OVF
|
||
|
|
deployment. An aspect has both a query-model and a deploy-model. The
|
||
|
|
query-model is used when the OVF package is queried, and the deploy-model
|
||
|
|
is used when deploying an OVF package.</p>
|
||
|
|
<p>Most OVF parameter classes provide both informational and deployment
|
||
|
|
parameters. However, some are purely informational (for example, download
|
||
|
|
size) and some are purely deployment parameters (for example, the flag to
|
||
|
|
indicate whether registration as a vCenter extension is accepted).</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</div></blockquote>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Unique identifier describing the type of the OVF parameters. The
|
||
|
|
value is the name of the OVF parameters class.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.OvfWarning">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">OvfWarning</tt><big>(</big><em>category=None</em>, <em>issues=None</em>, <em>name=None</em>, <em>value=None</em>, <em>message=None</em>, <em>error=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#OvfWarning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfWarning" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">OvfWarning</span></tt> class describes a warning related to accessing,
|
||
|
|
validating, deploying, or exporting an OVF package.</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>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="com.vmware.vcenter.ovf_client.OvfMessage.Category"><tt class="xref py py-class docutils literal"><span class="pre">OvfMessage.Category</span></tt></a>) – The message category.</li>
|
||
|
|
<li><strong>issues</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><tt class="xref py py-class docutils literal"><span class="pre">ParseIssue</span></tt></a>) – <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of parse issues (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><tt class="xref py py-class docutils literal"><span class="pre">ParseIssue</span></tt></a>).
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.VALIDATION</span></tt></a>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of input parameter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.INPUT</span></tt></a>.</li>
|
||
|
|
<li><strong>value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The value of input parameter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.INPUT</span></tt></a>.</li>
|
||
|
|
<li><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>) – A localizable message.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.INPUT</span></tt></a>.</li>
|
||
|
|
<li><strong>error</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.struct.VapiStruct</span></tt>) – Represents a server
|
||
|
|
<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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain all the attributes defined in
|
||
|
|
<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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>. When methods
|
||
|
|
return a value of this class as a return value, the attribute will
|
||
|
|
contain all the attributes defined in
|
||
|
|
<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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">category</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><tt class="xref py py-attr docutils literal"><span class="pre">OvfMessage.Category.SERVER</span></tt></a>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">ParseIssue</tt><big>(</big><em>category=None</em>, <em>file=None</em>, <em>line_number=None</em>, <em>column_number=None</em>, <em>message=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#ParseIssue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ParseIssue</span></tt> class contains the information about the issue found
|
||
|
|
when parsing an OVF package during deployment or exporting an OVF package
|
||
|
|
including:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>Parsing and validation error on OVF descriptor (which is an XML
|
||
|
|
document), manifest and certificate files.</li>
|
||
|
|
<li>OVF descriptor generating and device error.</li>
|
||
|
|
<li>Unexpected server error.</li>
|
||
|
|
</ul>
|
||
|
|
<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>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category" title="com.vmware.vcenter.ovf_client.ParseIssue.Category"><tt class="xref py py-class docutils literal"><span class="pre">ParseIssue.Category</span></tt></a>) – The category of the parse issue.</li>
|
||
|
|
<li><strong>file</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of the file in which the parse issue was found.</li>
|
||
|
|
<li><strong>line_number</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – The line number of the line in the file (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ParseIssue.file</span></tt>) where the parse issue was found (or -1 if
|
||
|
|
not applicable).</li>
|
||
|
|
<li><strong>column_number</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – The position in the line (see <tt class="xref py py-attr docutils literal"><span class="pre">ParseIssue.line_number</span></tt>) (or
|
||
|
|
-1 if not applicable).</li>
|
||
|
|
<li><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>) – A localizable message describing the parse issue.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category">
|
||
|
|
<em class="property">class </em><tt class="descname">Category</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#ParseIssue.Category"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ParseIssue.Category</span></tt> class defines the categories of issues that can
|
||
|
|
be found when parsing files inside an OVF package (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><tt class="xref py py-class docutils literal"><span class="pre">ParseIssue</span></tt></a>)
|
||
|
|
including OVF descriptor (which is an XML document), manifest and
|
||
|
|
certificate files, or exporting an OVF package.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">Category</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_ILLEGAL">
|
||
|
|
<tt class="descname">ATTRIBUTE_ILLEGAL</tt><em class="property"> = Category(string='ATTRIBUTE_ILLEGAL')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_ILLEGAL" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Illegal attribute error. It indicates that an illegal attribute is set for
|
||
|
|
an element in the OVF descriptor. For example, empty disks do not use
|
||
|
|
format, parentRef, and populatedSize attributes, if these attributes are
|
||
|
|
present in an empty disk element then will get this pasrse issue.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_REQUIRED">
|
||
|
|
<tt class="descname">ATTRIBUTE_REQUIRED</tt><em class="property"> = Category(string='ATTRIBUTE_REQUIRED')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_REQUIRED" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Required attribute error. It indicates that a required attribute is missing
|
||
|
|
from an element in the OVF descriptor.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_ILLEGAL">
|
||
|
|
<tt class="descname">ELEMENT_ILLEGAL</tt><em class="property"> = Category(string='ELEMENT_ILLEGAL')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_ILLEGAL" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Illegal element error. It indicates that an element is present in a
|
||
|
|
location which is not allowed, or found multiple elements but only one is
|
||
|
|
allowed at the location in the OVF descriptor.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_REQUIRED">
|
||
|
|
<tt class="descname">ELEMENT_REQUIRED</tt><em class="property"> = Category(string='ELEMENT_REQUIRED')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_REQUIRED" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Required element error. It indicates that a required element is missing
|
||
|
|
from the OVF descriptor.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_UNKNOWN">
|
||
|
|
<tt class="descname">ELEMENT_UNKNOWN</tt><em class="property"> = Category(string='ELEMENT_UNKNOWN')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Unknown element error. It indicates that an element is unsupported when
|
||
|
|
parsing an OVF descriptor.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.EXPORT_ERROR">
|
||
|
|
<tt class="descname">EXPORT_ERROR</tt><em class="property"> = Category(string='EXPORT_ERROR')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.EXPORT_ERROR" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Issue during OVF export, for example, malformed deviceId, controller not
|
||
|
|
found, or file backing for a device not found.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.GENERATE_ERROR">
|
||
|
|
<tt class="descname">GENERATE_ERROR</tt><em class="property"> = Category(string='GENERATE_ERROR')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.GENERATE_ERROR" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>OVF descriptor (which is an XML document) generating error, for example,
|
||
|
|
well-formedness errors as well as unexpected processing conditions.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.INTERNAL_ERROR">
|
||
|
|
<tt class="descname">INTERNAL_ERROR</tt><em class="property"> = Category(string='INTERNAL_ERROR')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.INTERNAL_ERROR" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Server encountered an unexpected error which prevented it from fulfilling
|
||
|
|
the request.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.PARSE_ERROR">
|
||
|
|
<tt class="descname">PARSE_ERROR</tt><em class="property"> = Category(string='PARSE_ERROR')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.PARSE_ERROR" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>OVF package parsing error, including:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>OVF descriptor parsing errors, for example, syntax errors or schema
|
||
|
|
errors.</li>
|
||
|
|
<li>Manifest file parsing and verification errors.</li>
|
||
|
|
<li>Certificate file parsing and verification errors.</li>
|
||
|
|
</ul>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_RESTRICTION">
|
||
|
|
<tt class="descname">SECTION_RESTRICTION</tt><em class="property"> = Category(string='SECTION_RESTRICTION')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_RESTRICTION" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Section restriction error. It indicates that a section appears in place in
|
||
|
|
the OVF descriptor where it is not allowed, a section appears fewer times
|
||
|
|
than is required, or a section appears more times than is allowed.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_UNKNOWN">
|
||
|
|
<tt class="descname">SECTION_UNKNOWN</tt><em class="property"> = Category(string='SECTION_UNKNOWN')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Section unknown error. It indicates that a section is unsupported when
|
||
|
|
parsing an OVF descriptor.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.VALIDATION_ERROR">
|
||
|
|
<tt class="descname">VALIDATION_ERROR</tt><em class="property"> = Category(string='VALIDATION_ERROR')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.VALIDATION_ERROR" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>An issue with the manifest and signing.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.VALUE_ILLEGAL">
|
||
|
|
<tt class="descname">VALUE_ILLEGAL</tt><em class="property"> = Category(string='VALUE_ILLEGAL')</em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.VALUE_ILLEGAL" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Illegal value error. For example, the value is malformed, not a number, or
|
||
|
|
outside of the given range, and so on.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.Property">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">Property</tt><big>(</big><em>class_id=None</em>, <em>id=None</em>, <em>instance_id=None</em>, <em>category=None</em>, <em>ui_optional=None</em>, <em>label=None</em>, <em>description=None</em>, <em>type=None</em>, <em>value=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#Property"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.Property" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Property</span></tt> class contains the information about a property in an OVF
|
||
|
|
package.</p>
|
||
|
|
<p>A property is uniquely identified by its [classid.]id[.instanceid]
|
||
|
|
fully-qualified name (see <tt class="xref py py-attr docutils literal"><span class="pre">Property.class_id</span></tt>, <tt class="xref py py-attr docutils literal"><span class="pre">Property.id</span></tt>,
|
||
|
|
and <tt class="xref py py-attr docutils literal"><span class="pre">Property.instance_id</span></tt>). If multiple properties in an OVF package
|
||
|
|
have the same fully-qualified name, then the property is excluded and
|
||
|
|
cannot be set. We do warn about this during import.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</div></blockquote>
|
||
|
|
<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>class_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The classId of this OVF property.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of this OVF property.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>instance_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The instanceId of this OVF property.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>category</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – If this is set to a non-empty string, this property starts a new
|
||
|
|
category.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute is optional in the result when
|
||
|
|
retrieving information about an OVF package. If None, the property
|
||
|
|
is in the same category as the previous item, otherwise, it starts
|
||
|
|
a new category.</li>
|
||
|
|
<li><strong>ui_optional</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – <p>Whether a category is UI optional. This is only used if this
|
||
|
|
property starts a new category (see <tt class="xref py py-attr docutils literal"><span class="pre">Property.category</span></tt>).</p>
|
||
|
|
<p>The value is stored in an optional attribute vmw:uioptional to the
|
||
|
|
ovf:Category element. The default value is false. If this value is
|
||
|
|
true, the properties within this category are optional. The UI
|
||
|
|
renders this as a group with a check box, and the group is grayed
|
||
|
|
out until the check box is selected. When the check box is
|
||
|
|
selected, the input values are read and used in deployment. If
|
||
|
|
properties within the same category specify conflicting values the
|
||
|
|
default is used. Only implemented in vSphere Web Client 5.1 and
|
||
|
|
later as of Nov 2012.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute is optional in the result when
|
||
|
|
retrieving information about an OVF package.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>label</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The display name of this OVF property.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – A description of this OVF property.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute is optional in the result when
|
||
|
|
retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The type of this OVF property. Refer to the configuration of a
|
||
|
|
virtual appliance/virtual machine for the valid values.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The OVF property value. This contains the default value from
|
||
|
|
ovf:defaultValue if ovf:value is not present when read.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.PropertyParams">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">PropertyParams</tt><big>(</big><em>properties=None</em>, <em>type=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#PropertyParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.PropertyParams" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">PropertyParams</span></tt> class contains a <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of OVF properties
|
||
|
|
that can be configured when the OVF package is deployed.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><p>This is based on the ovf:ProductSection.</p>
|
||
|
|
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</p>
|
||
|
|
</div></blockquote>
|
||
|
|
<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>properties</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.Property" title="com.vmware.vcenter.ovf_client.Property"><tt class="xref py py-class docutils literal"><span class="pre">Property</span></tt></a>) – <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of OVF properties.
|
||
|
|
This attribute is optional in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Unique identifier describing the type of the OVF parameters. The
|
||
|
|
value is the name of the OVF parameters class.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ScaleOutGroup">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">ScaleOutGroup</tt><big>(</big><em>id=None</em>, <em>description=None</em>, <em>instance_count=None</em>, <em>minimum_instance_count=None</em>, <em>maximum_instance_count=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#ScaleOutGroup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ScaleOutGroup" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ScaleOutGroup</span></tt> class contains information about a scale-out group.</p>
|
||
|
|
<p>It allows a virtual system collection to contain a set of children that are
|
||
|
|
homogeneous with respect to a prototypical virtual system or virtual system
|
||
|
|
collection. It shall cause the deployment function to replicate the
|
||
|
|
prototype a number of times, thus allowing the number of instantiated
|
||
|
|
virtual systems to be configured dynamically at deployment time.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><p>This is based on the ovf2:ScaleOutSection.</p>
|
||
|
|
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</p>
|
||
|
|
</div></blockquote>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the scale-out group.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The description of the scale-out group.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>instance_count</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – The scaling factor to use. It defines the number of replicas of the
|
||
|
|
prototypical virtual system or virtual system collection.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>minimum_instance_count</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – The minimum scaling factor.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package. This will be 1 if
|
||
|
|
there is no explicit limit.</li>
|
||
|
|
<li><strong>maximum_instance_count</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – The maximum scaling factor.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute is optional in the result when
|
||
|
|
retrieving information about an OVF package. This will be None if
|
||
|
|
there is no explicit limit.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.ScaleOutParams">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">ScaleOutParams</tt><big>(</big><em>groups=None</em>, <em>type=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#ScaleOutParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ScaleOutParams" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ScaleOutParams</span></tt> class contains information about the scale-out
|
||
|
|
groups described in the OVF package.</p>
|
||
|
|
<p>When deploying an OVF package, a deployment specific instance count can be
|
||
|
|
specified (see <tt class="xref py py-attr docutils literal"><span class="pre">ScaleOutGroup.instance_count</span></tt>.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><p>This is based on the ovf2:ScaleOutSection.</p>
|
||
|
|
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</p>
|
||
|
|
</div></blockquote>
|
||
|
|
<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>groups</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ScaleOutGroup" title="com.vmware.vcenter.ovf_client.ScaleOutGroup"><tt class="xref py py-class docutils literal"><span class="pre">ScaleOutGroup</span></tt></a>) – The <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of scale-out groups.
|
||
|
|
This attribute is optional in the input parameters when deploying
|
||
|
|
an OVF package. If None there are no scale-out groups. This
|
||
|
|
attribute will always be present in the result when retrieving
|
||
|
|
information about an OVF package.</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Unique identifier describing the type of the OVF parameters. The
|
||
|
|
value is the name of the OVF parameters class.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.SizeParams">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">SizeParams</tt><big>(</big><em>approximate_download_size=None</em>, <em>approximate_flat_deployment_size=None</em>, <em>approximate_sparse_deployment_size=None</em>, <em>variable_disk_size=None</em>, <em>type=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#SizeParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.SizeParams" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">SizeParams</span></tt> class contains estimates of the download and deployment
|
||
|
|
sizes.</p>
|
||
|
|
<p>This information is based on the file references and the ovf:DiskSection in
|
||
|
|
the OVF descriptor.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</div></blockquote>
|
||
|
|
<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>approximate_download_size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – <p>A best guess as to the total amount of data that must be
|
||
|
|
transferred to download the OVF package.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>This may be inaccurate due to disk compression etc.</div></blockquote>
|
||
|
|
<p>This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute is optional in the result when
|
||
|
|
retrieving information about an OVF package. It will be None if
|
||
|
|
there is insufficient information to provide a proper estimate.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>approximate_flat_deployment_size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – A best guess as to the total amount of space required to deploy the
|
||
|
|
OVF package if using flat disks.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute is optional in the result when
|
||
|
|
retrieving information about an OVF package. It will be None if
|
||
|
|
there is insufficient information to provide a proper estimate.</li>
|
||
|
|
<li><strong>approximate_sparse_deployment_size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – A best guess as to the total amount of space required to deploy the
|
||
|
|
OVF package using sparse disks.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute is optional in the result when
|
||
|
|
retrieving information about an OVF package. It will be None if
|
||
|
|
there is insufficient information to provide a proper estimate.</li>
|
||
|
|
<li><strong>variable_disk_size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – <p>Whether the OVF uses variable disk sizes.</p>
|
||
|
|
<p>For empty disks, rather than specifying a fixed virtual disk
|
||
|
|
capacity, the capacity may be given using a reference to a
|
||
|
|
ovf:Property element in a ovf:ProductSection element in OVF
|
||
|
|
package.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute is optional in the result when
|
||
|
|
retrieving information about an OVF package. If None or false, the
|
||
|
|
OVF does not use variable disk sizes.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Unique identifier describing the type of the OVF parameters. The
|
||
|
|
value is the name of the OVF parameters class.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.UnknownSection">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">UnknownSection</tt><big>(</big><em>tag=None</em>, <em>info=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#UnknownSection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.UnknownSection" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">UnknownSection</span></tt> class contains information about an unknown section
|
||
|
|
in an OVF package.</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>tag</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – A namespace-qualified tag in the form <tt class="docutils literal"><span class="pre">{ns}tag</span></tt>.</li>
|
||
|
|
<li><strong>info</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The description of the Info element.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.UnknownSectionParams">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">UnknownSectionParams</tt><big>(</big><em>unknown_sections=None</em>, <em>type=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#UnknownSectionParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.UnknownSectionParams" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">UnknownSectionParams</span></tt> class contains a <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of unknown,
|
||
|
|
non-required sections.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</div></blockquote>
|
||
|
|
<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>unknown_sections</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.UnknownSection" title="com.vmware.vcenter.ovf_client.UnknownSection"><tt class="xref py py-class docutils literal"><span class="pre">UnknownSection</span></tt></a>) – <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of unknown, non-required sections.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Unique identifier describing the type of the OVF parameters. The
|
||
|
|
value is the name of the OVF parameters class.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.ovf_client.VcenterExtensionParams">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.ovf_client.</tt><tt class="descname">VcenterExtensionParams</tt><big>(</big><em>required=None</em>, <em>registration_accepted=None</em>, <em>type=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/vcenter/ovf_client.html#VcenterExtensionParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.vcenter.ovf_client.VcenterExtensionParams" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">VcenterExtensionParams</span></tt> class specifies that the OVF package should
|
||
|
|
be registered as a vCenter extension. The virtual machine or virtual
|
||
|
|
appliance will gain unrestricted access to the vCenter Server APIs. It must
|
||
|
|
be connected to a network with connectivity to the vCenter server.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.deploy()</span></tt></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><tt class="xref py py-func docutils literal"><span class="pre">LibraryItem.filter()</span></tt></a>.</div></blockquote>
|
||
|
|
<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>required</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Whether registration as a vCenter extension is required.
|
||
|
|
This attribute is not used in the input parameters when deploying
|
||
|
|
an OVF package. This attribute will always be present in the result
|
||
|
|
when retrieving information about an OVF package.</li>
|
||
|
|
<li><strong>registration_accepted</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – <p>Whether registration as a vCenter extension is accepted.</p>
|
||
|
|
<p>If registration as a vCenter extension is required (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">VcenterExtensionParams.required</span></tt>), this must be set to true
|
||
|
|
during deployment. Defaults to false when returned from server.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Unique identifier describing the type of the OVF parameters. The
|
||
|
|
value is the name of the OVF parameters class.
|
||
|
|
This attribute must be provided in the input parameters when
|
||
|
|
deploying an OVF package. This attribute will always be present in
|
||
|
|
the result when retrieving information about an OVF package.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar">
|
||
|
|
<div class="sphinxsidebarwrapper">
|
||
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#">vcenter Package</a><ul>
|
||
|
|
<li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">vcenter</span></tt> Package</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.vcenter.inventory_client"><tt class="docutils literal"><span class="pre">inventory_client</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.vcenter.ovf_client"><tt class="docutils literal"><span class="pre">ovf_client</span></tt> Module</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h4>Previous topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.vapi.std.html"
|
||
|
|
title="previous chapter">std Package</a></p>
|
||
|
|
<h4>Next topic</h4>
|
||
|
|
<p class="topless"><a href="vmware.html"
|
||
|
|
title="next chapter">vmware Package</a></p>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="_sources/com.vmware.vcenter.txt"
|
||
|
|
rel="nofollow">Show Source</a></li>
|
||
|
|
</ul>
|
||
|
|
<div id="searchbox" style="display: none">
|
||
|
|
<h3>Quick search</h3>
|
||
|
|
<form class="search" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" />
|
||
|
|
<input type="submit" value="Go" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
<p class="searchtip" style="font-size: 90%">
|
||
|
|
Enter search terms or a module, class or function name.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
>index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="vmware.html" title="vmware Package"
|
||
|
|
>next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.vapi.std.html" title="std Package"
|
||
|
|
>previous</a> |</li>
|
||
|
|
<li><a href="index.html">vCloud Suite SDK for Python 6.0.0 documentation</a> »</li>
|
||
|
|
<li><a href="com.html" >com Package</a> »</li>
|
||
|
|
<li><a href="com.vmware.html" >vmware Package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2014, VMware, Inc..
|
||
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|