mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
4697 lines
374 KiB
HTML
4697 lines
374 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<title>com.vmware package — vSphere Automation SDK for Python 6.6.1 documentation</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: './',
|
||
|
|
VERSION: '6.6.1',
|
||
|
|
COLLAPSE_INDEX: false,
|
||
|
|
FILE_SUFFIX: '.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
|
<link rel="top" title="vSphere Automation SDK for Python 6.6.1 documentation" href="index.html" />
|
||
|
|
<link rel="up" title="com package" href="com.html" />
|
||
|
|
<link rel="next" title="com.vmware.appliance package" href="com.vmware.appliance.html" />
|
||
|
|
<link rel="prev" title="com package" href="com.html" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
accesskey="I">index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.appliance.html" title="com.vmware.appliance package"
|
||
|
|
accesskey="N">next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.html" title="com package"
|
||
|
|
accesskey="P">previous</a> |</li>
|
||
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> »</li>
|
||
|
|
<li><a href="com.html" accesskey="U">com package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body">
|
||
|
|
|
||
|
|
<div class="section" id="com-vmware-package">
|
||
|
|
<h1>com.vmware package<a class="headerlink" href="#com-vmware-package" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="section" id="subpackages">
|
||
|
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<div class="toctree-wrapper compound">
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.appliance.html">com.vmware.appliance package</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#subpackages">Subpackages</a><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.appliance.networking.html">com.vmware.appliance.networking package</a><ul>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.networking.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.dns_client">com.vmware.appliance.networking.dns_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.appliance.recovery.html">com.vmware.appliance.recovery package</a><ul>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.recovery.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.backup_client">com.vmware.appliance.recovery.backup_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.restore_client">com.vmware.appliance.recovery.restore_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.appliance.techpreview.html">com.vmware.appliance.techpreview package</a><ul>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.techpreview.html#subpackages">Subpackages</a><ul>
|
||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.html">com.vmware.appliance.techpreview.networking package</a><ul>
|
||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.html#subpackages">Subpackages</a><ul>
|
||
|
|
<li class="toctree-l7"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.firewall.html">com.vmware.appliance.techpreview.networking.firewall package</a><ul>
|
||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.firewall.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.firewall.html#module-com.vmware.appliance.techpreview.networking.firewall.addr_client">com.vmware.appliance.techpreview.networking.firewall.addr_client module</a></li>
|
||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.firewall.html#module-com.vmware.appliance.techpreview.networking.firewall">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.techpreview.networking.html#module-com.vmware.appliance.techpreview.networking">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.techpreview.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview.localaccounts_client">com.vmware.appliance.techpreview.localaccounts_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview.monitoring_client">com.vmware.appliance.techpreview.monitoring_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview.networking_client">com.vmware.appliance.techpreview.networking_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview.ntp_client">com.vmware.appliance.techpreview.ntp_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview.services_client">com.vmware.appliance.techpreview.services_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview.system_client">com.vmware.appliance.techpreview.system_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.techpreview.html#module-com.vmware.appliance.techpreview">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.access_client">com.vmware.appliance.access_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.health_client">com.vmware.appliance.health_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.networking_client">com.vmware.appliance.networking_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.recovery_client">com.vmware.appliance.recovery_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.system_client">com.vmware.appliance.system_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.techpreview_client">com.vmware.appliance.techpreview_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.vmon_client">com.vmware.appliance.vmon_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.cis.html">com.vmware.cis package</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.cis.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.cis.html#module-com.vmware.cis.tagging_client">com.vmware.cis.tagging_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.cis.html#module-com.vmware.cis">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.content.html">com.vmware.content package</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.html#subpackages">Subpackages</a><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.content.library.html">com.vmware.content.library package</a><ul>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.library.html#subpackages">Subpackages</a><ul>
|
||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.content.library.item.html">com.vmware.content.library.item package</a><ul>
|
||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.library.item.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.downloadsession_client">com.vmware.content.library.item.downloadsession_client module</a></li>
|
||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.updatesession_client">com.vmware.content.library.item.updatesession_client module</a></li>
|
||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.library.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.library.html#module-com.vmware.content.library.item_client">com.vmware.content.library.item_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.library.html#module-com.vmware.content.library">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.html#module-com.vmware.content.library_client">com.vmware.content.library_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.html#module-com.vmware.content">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vapi.html">com.vmware.vapi package</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.html#subpackages">Subpackages</a><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.std.html">com.vmware.vapi.std package</a><ul>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.html#module-com.vmware.vapi.std_client">com.vmware.vapi.std_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.html#module-com.vmware.vapi">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.html">com.vmware.vcenter package</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#subpackages">Subpackages</a><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.hvc.html">com.vmware.vcenter.hvc package</a><ul>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.hvc.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc.management_client">com.vmware.vcenter.hvc.management_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.vm.html">com.vmware.vcenter.vm package</a><ul>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.html#subpackages">Subpackages</a><ul>
|
||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html">com.vmware.vcenter.vm.hardware package</a><ul>
|
||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.adapter_client">com.vmware.vcenter.vm.hardware.adapter_client module</a></li>
|
||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.boot_client">com.vmware.vcenter.vm.hardware.boot_client module</a></li>
|
||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.hardware_client">com.vmware.vcenter.vm.hardware_client module</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.hvc_client">com.vmware.vcenter.hvc_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.inventory_client">com.vmware.vcenter.inventory_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.iso_client">com.vmware.vcenter.iso_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.ovf_client">com.vmware.vcenter.ovf_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.vm_client">com.vmware.vcenter.vm_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="submodules">
|
||
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.appliance_client">
|
||
|
|
<span id="com-vmware-appliance-client-module"></span><h2>com.vmware.appliance_client module<a class="headerlink" href="#module-com.vmware.appliance_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance_client.</tt><tt class="descname">Monitoring</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance_client.Monitoring" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p><tt class="docutils literal"><span class="pre">Monitoring</span></tt> class provides methods Get and list monitoring data for
|
||
|
|
requested item.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.FunctionType">
|
||
|
|
<em class="property">class </em><tt class="descname">FunctionType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.FunctionType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p><tt class="docutils literal"><span class="pre">Monitoring.FunctionType</span></tt> class Defines aggregation function</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">FunctionType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.FunctionType.AVG">
|
||
|
|
<tt class="descname">AVG</tt><em class="property"> = FunctionType(string=u'AVG')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.FunctionType.AVG" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Aggregation takes average per period</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.FunctionType.COUNT">
|
||
|
|
<tt class="descname">COUNT</tt><em class="property"> = FunctionType(string=u'COUNT')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.FunctionType.COUNT" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Aggregation takes count per period (sum)</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.FunctionType.MAX">
|
||
|
|
<tt class="descname">MAX</tt><em class="property"> = FunctionType(string=u'MAX')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.FunctionType.MAX" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Aggregation takes maximums per period</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.FunctionType.MIN">
|
||
|
|
<tt class="descname">MIN</tt><em class="property"> = FunctionType(string=u'MIN')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.FunctionType.MIN" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Aggregation takes minimums per period</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Monitoring.</tt><tt class="descname">IntervalType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p><tt class="docutils literal"><span class="pre">Monitoring.IntervalType</span></tt> class Defines interval between the values in
|
||
|
|
hours and mins, for which aggregation will apply</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">IntervalType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType.DAY1">
|
||
|
|
<tt class="descname">DAY1</tt><em class="property"> = IntervalType(string=u'DAY1')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType.DAY1" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>24 hours interval between values. One year has 365 values.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType.HOURS2">
|
||
|
|
<tt class="descname">HOURS2</tt><em class="property"> = IntervalType(string=u'HOURS2')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType.HOURS2" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Two hours interval between values. One month has 360 values.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType.HOURS6">
|
||
|
|
<tt class="descname">HOURS6</tt><em class="property"> = IntervalType(string=u'HOURS6')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType.HOURS6" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Six hour interval between values. One quarter is 360 values.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType.MINUTES30">
|
||
|
|
<tt class="descname">MINUTES30</tt><em class="property"> = IntervalType(string=u'MINUTES30')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType.MINUTES30" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Thirty minutes interval between values. One week is 336 values.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType.MINUTES5">
|
||
|
|
<tt class="descname">MINUTES5</tt><em class="property"> = IntervalType(string=u'MINUTES5')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType.MINUTES5" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Five minutes interval between values (finest). One day would have 288
|
||
|
|
values, one week is 2016.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.MonitoredItem">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Monitoring.</tt><tt class="descname">MonitoredItem</tt><big>(</big><em>id=None</em>, <em>name=None</em>, <em>units=None</em>, <em>category=None</em>, <em>instance=None</em>, <em>description=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.MonitoredItem" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p><tt class="docutils literal"><span class="pre">Monitoring.MonitoredItem</span></tt> class Structure representing requested
|
||
|
|
monitored item data.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – monitored item ID Ex: CPU, MEMORY
|
||
|
|
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.appliance.monitoring</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.appliance.monitoring</span></tt>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – monitored item name Ex: “Network write speed”</li>
|
||
|
|
<li><strong>units</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Y-axis label EX: “Mbps”, “%”</li>
|
||
|
|
<li><strong>category</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – category Ex: network, storage etc</li>
|
||
|
|
<li><strong>instance</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – instance name Ex: eth0</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – monitored item description Ex:
|
||
|
|
com.vmware.applmgmt.mon.descr.net.rx.packetRate.eth0</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.MonitoredItemData">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Monitoring.</tt><tt class="descname">MonitoredItemData</tt><big>(</big><em>name=None</em>, <em>interval=None</em>, <em>function=None</em>, <em>start_time=None</em>, <em>end_time=None</em>, <em>data=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.MonitoredItemData" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p><tt class="docutils literal"><span class="pre">Monitoring.MonitoredItemData</span></tt> class Structure representing monitored
|
||
|
|
item data.</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>) – Monitored item IDs Ex: CPU, MEMORY, STORAGE_TOTAL
|
||
|
|
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.appliance.monitoring</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.appliance.monitoring</span></tt>.</li>
|
||
|
|
<li><strong>interval</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Monitoring.IntervalType" title="com.vmware.appliance_client.Monitoring.IntervalType"><tt class="xref py py-class docutils literal"><span class="pre">Monitoring.IntervalType</span></tt></a>) – interval between values in hours, minutes</li>
|
||
|
|
<li><strong>function</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Monitoring.FunctionType" title="com.vmware.appliance_client.Monitoring.FunctionType"><tt class="xref py py-class docutils literal"><span class="pre">Monitoring.FunctionType</span></tt></a>) – aggregation function</li>
|
||
|
|
<li><strong>start_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Starting time</li>
|
||
|
|
<li><strong>end_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Ending time</li>
|
||
|
|
<li><strong>data</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>) – list of values</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Monitoring.</tt><tt class="descname">MonitoredItemDataRequest</tt><big>(</big><em>names=None</em>, <em>interval=None</em>, <em>function=None</em>, <em>start_time=None</em>, <em>end_time=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p><tt class="docutils literal"><span class="pre">Monitoring.MonitoredItemDataRequest</span></tt> class Structure representing
|
||
|
|
requested monitored item data.</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>names</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>) – monitored item IDs Ex: CPU, MEMORY
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.monitoring</span></tt>. When methods return a value of
|
||
|
|
this class as a return value, the attribute will contain
|
||
|
|
identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.monitoring</span></tt>.</li>
|
||
|
|
<li><strong>interval</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Monitoring.IntervalType" title="com.vmware.appliance_client.Monitoring.IntervalType"><tt class="xref py py-class docutils literal"><span class="pre">Monitoring.IntervalType</span></tt></a>) – interval between values in hours, minutes</li>
|
||
|
|
<li><strong>function</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Monitoring.FunctionType" title="com.vmware.appliance_client.Monitoring.FunctionType"><tt class="xref py py-class docutils literal"><span class="pre">Monitoring.FunctionType</span></tt></a>) – aggregation function</li>
|
||
|
|
<li><strong>start_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Starting time</li>
|
||
|
|
<li><strong>end_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Ending time</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.get">
|
||
|
|
<tt class="descclassname">Monitoring.</tt><tt class="descname">get</tt><big>(</big><em>stat_id</em><big>)</big><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get monitored item info</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>stat_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – statistic item id
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.monitoring</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.Monitoring.MonitoredItem" title="com.vmware.appliance_client.Monitoring.MonitoredItem"><tt class="xref py py-class docutils literal"><span class="pre">Monitoring.MonitoredItem</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">MonitoredItem structure</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
Generic error</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.list">
|
||
|
|
<tt class="descclassname">Monitoring.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get monitored items list</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">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.Monitoring.list" title="com.vmware.appliance_client.Monitoring.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.appliance_client.Monitoring.MonitoredItem" title="com.vmware.appliance_client.Monitoring.MonitoredItem"><tt class="xref py py-class docutils literal"><span class="pre">Monitoring.MonitoredItem</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of names</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
Generic error</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance_client.Monitoring.query">
|
||
|
|
<tt class="descclassname">Monitoring.</tt><tt class="descname">query</tt><big>(</big><em>item</em><big>)</big><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.query" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get monitoring data.</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>item</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest" title="com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest"><tt class="xref py py-class docutils literal"><span class="pre">Monitoring.MonitoredItemDataRequest</span></tt></a>) – MonitoredItemDataRequest Structure</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.Monitoring.list" title="com.vmware.appliance_client.Monitoring.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.appliance_client.Monitoring.MonitoredItemData" title="com.vmware.appliance_client.Monitoring.MonitoredItemData"><tt class="xref py py-class docutils literal"><span class="pre">Monitoring.MonitoredItemData</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of MonitoredItemData structure</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
Generic error</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.cis_client">
|
||
|
|
<span id="com-vmware-cis-client-module"></span><h2>com.vmware.cis_client module<a class="headerlink" href="#module-com.vmware.cis_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">com.vmware.cis_client</span></tt> module provides VMware common infrastructure
|
||
|
|
classes such as session and task.</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis_client.Session">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.cis_client.</tt><tt class="descname">Session</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.cis_client.Session" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Session</span></tt> class allows API clients to manage session tokens including
|
||
|
|
creating, deleting and obtaining information about sessions.</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>The <a class="reference internal" href="#com.vmware.cis_client.Session.create" title="com.vmware.cis_client.Session.create"><tt class="xref py py-func docutils literal"><span class="pre">Session.create()</span></tt></a> method creates session token in exchange for
|
||
|
|
another authentication token.</li>
|
||
|
|
<li>The <a class="reference internal" href="#com.vmware.cis_client.Session.delete" title="com.vmware.cis_client.Session.delete"><tt class="xref py py-func docutils literal"><span class="pre">Session.delete()</span></tt></a> method invalidates a session token.</li>
|
||
|
|
<li>The <a class="reference internal" href="#com.vmware.cis_client.Session.get" title="com.vmware.cis_client.Session.get"><tt class="xref py py-func docutils literal"><span class="pre">Session.get()</span></tt></a> retrieves information about a session token.</li>
|
||
|
|
</ul>
|
||
|
|
<p>The call to the <a class="reference internal" href="#com.vmware.cis_client.Session.create" title="com.vmware.cis_client.Session.create"><tt class="xref py py-func docutils literal"><span class="pre">Session.create()</span></tt></a> method is part of the overall
|
||
|
|
authentication process for API clients. For example, the sequence of steps
|
||
|
|
for establishing a session with SAML token is:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>Connect to lookup service.</li>
|
||
|
|
<li>Discover the secure token service (STS) endpoint URL.</li>
|
||
|
|
<li>Connect to the secure token service to obtain a SAML token.</li>
|
||
|
|
<li>Authenticate to the lookup service using the obtained SAML token.</li>
|
||
|
|
<li>Discover the API endpoint URL from lookup service.</li>
|
||
|
|
<li>Call the <a class="reference internal" href="#com.vmware.cis_client.Session.create" title="com.vmware.cis_client.Session.create"><tt class="xref py py-func docutils literal"><span class="pre">Session.create()</span></tt></a> method. The <a class="reference internal" href="#com.vmware.cis_client.Session.create" title="com.vmware.cis_client.Session.create"><tt class="xref py py-func docutils literal"><span class="pre">Session.create()</span></tt></a> call
|
||
|
|
must include the SAML token.</li>
|
||
|
|
</ul>
|
||
|
|
<p>See the programming guide and samples for additional information about
|
||
|
|
establishing API sessions.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><strong>Execution Context and Security Context</strong></div></blockquote>
|
||
|
|
<p>To use session based authentication a client should supply the session
|
||
|
|
token obtained through the <a class="reference internal" href="#com.vmware.cis_client.Session.create" title="com.vmware.cis_client.Session.create"><tt class="xref py py-func docutils literal"><span class="pre">Session.create()</span></tt></a> method. The client should
|
||
|
|
add the session token in the security context when using SDK classes.
|
||
|
|
Clients using the REST API should supply the session token as a HTTP
|
||
|
|
header.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><strong>Session Lifetime</strong></div></blockquote>
|
||
|
|
<p>A session begins with call to the <a class="reference internal" href="#com.vmware.cis_client.Session.create" title="com.vmware.cis_client.Session.create"><tt class="xref py py-func docutils literal"><span class="pre">Session.create()</span></tt></a> method to exchange
|
||
|
|
a SAML token for a API session token. A session ends under the following
|
||
|
|
circumstances:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>Call to the <a class="reference internal" href="#com.vmware.cis_client.Session.delete" title="com.vmware.cis_client.Session.delete"><tt class="xref py py-func docutils literal"><span class="pre">Session.delete()</span></tt></a> method.</li>
|
||
|
|
<li>The session expires. Session expiration may be caused by one of the
|
||
|
|
following situations:</li>
|
||
|
|
<li>Client inactivity - For a particular session identified by client
|
||
|
|
requests that specify the associated session ID, the lapsed time since the
|
||
|
|
last request exceeds the maximum interval between requests.</li>
|
||
|
|
<li>Unconditional or absolute session expiration time: At the beginning of
|
||
|
|
the session, the session logic uses the SAML token and the system
|
||
|
|
configuration to calculate absolute expiration time.</li>
|
||
|
|
</ul>
|
||
|
|
<p>When a session ends, the authentication logic will reject any subsequent
|
||
|
|
client requests that specify that session. Any operations in progress will
|
||
|
|
continue to completion.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><p><strong>Error Handling</strong></p>
|
||
|
|
<p>The <a class="reference internal" href="#com.vmware.cis_client.Session" title="com.vmware.cis_client.Session"><tt class="xref py py-class docutils literal"><span class="pre">Session</span></tt></a> returns the following exceptions:</p>
|
||
|
|
</div></blockquote>
|
||
|
|
<ul class="simple">
|
||
|
|
<li><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt> exception for
|
||
|
|
any exceptions related to the request.</li>
|
||
|
|
<li><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt> exception
|
||
|
|
for all exceptions caused by internal service failure.</li>
|
||
|
|
</ul>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis_client.Session.Info">
|
||
|
|
<em class="property">class </em><tt class="descname">Info</tt><big>(</big><em>user=None</em>, <em>created_time=None</em>, <em>last_accessed_time=None</em><big>)</big><a class="headerlink" href="#com.vmware.cis_client.Session.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>Represents data associated with an API session.</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>user</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Fully qualified name of the end user that created the session, for
|
||
|
|
example Administrator\@vsphere.local. A typical use case for
|
||
|
|
this information is in Graphical User Interfaces (GUI) or logging
|
||
|
|
systems to visualize the identity of the current user.</li>
|
||
|
|
<li><strong>created_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Time when the session was created.</li>
|
||
|
|
<li><strong>last_accessed_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Last time this session was used by passing the session key for
|
||
|
|
invoking an API.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis_client.Session.create">
|
||
|
|
<tt class="descclassname">Session.</tt><tt class="descname">create</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.cis_client.Session.create" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Creates a session with the API. This is the equivalent of login. This
|
||
|
|
method exchanges user credentials supplied in the security context for
|
||
|
|
a session identifier that is to be used for authenticating subsequent
|
||
|
|
calls. To authenticate subsequent calls clients are expected to include
|
||
|
|
the session key.</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">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Newly created session identifier to be used for authenticating
|
||
|
|
further requests.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the session creation fails due to request specific issues. Due
|
||
|
|
to the security nature of the API the details of the error are not
|
||
|
|
disclosed.</p>
|
||
|
|
<p>Please check the following preconditions if using a SAML token to
|
||
|
|
authenticate:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>the supplied token is delegate-able.</li>
|
||
|
|
<li>the time of client and server system are synchronized.</li>
|
||
|
|
<li>the token supplied is valid.</li>
|
||
|
|
<li>if bearer tokens are used check that system configuration allows
|
||
|
|
the API endpoint to accept such tokens.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if session creation fails due to server specific issues, for
|
||
|
|
example connection to a back end component is failing. Due to the
|
||
|
|
security nature of this API further details will not be disclosed
|
||
|
|
in the exception. Please refer to component health information,
|
||
|
|
administrative logs and product specific documentation for possible
|
||
|
|
causes.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis_client.Session.delete">
|
||
|
|
<tt class="descclassname">Session.</tt><tt class="descname">delete</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.cis_client.Session.delete" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Terminates the validity of a session token. This is the equivalent of
|
||
|
|
log out.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>A session identifier is expected as part of the request.</div></blockquote>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the session id is missing from the request or the corresponding
|
||
|
|
session object cannot be found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if session deletion fails due to server specific issues, for
|
||
|
|
example connection to a back end component is failing. Due to the
|
||
|
|
security nature of this API further details will not be disclosed
|
||
|
|
in the exception. Please refer to component health information,
|
||
|
|
administrative logs and product specific documentation for possible
|
||
|
|
causes.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis_client.Session.get">
|
||
|
|
<tt class="descclassname">Session.</tt><tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.cis_client.Session.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns information about the current session. This method expects a
|
||
|
|
valid session identifier to be supplied.</p>
|
||
|
|
<p>A side effect of invoking this method may be a change to the session’s
|
||
|
|
last accessed time to the current time if this is supported by the
|
||
|
|
session implementation. Invoking any other method in the API will also
|
||
|
|
update the session’s last accessed time.</p>
|
||
|
|
<p>This API is meant to serve the needs of various front end projects that
|
||
|
|
may want to display the name of the user. Examples of this include
|
||
|
|
various web based user interfaces and logging facilities.</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">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.cis_client.Session.Info" title="com.vmware.cis_client.Session.Info"><tt class="xref py py-class docutils literal"><span class="pre">Session.Info</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Information about the session.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the session id is missing from the request or the corresponding
|
||
|
|
session object cannot be found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if session retrieval fails due to server specific issues e.g.
|
||
|
|
connection to back end component is failing. Due to the security
|
||
|
|
nature of this API further details will not be disclosed in the
|
||
|
|
error. Please refer to component health information, administrative
|
||
|
|
logs and product specific documentation for possible causes.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.content_client">
|
||
|
|
<span id="com-vmware-content-client-module"></span><h2>com.vmware.content_client module<a class="headerlink" href="#module-com.vmware.content_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>The Content module provides classes and classes for configuring global settings
|
||
|
|
and permissions, and for managing libraries in the Content Library Service.</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content_client.Configuration">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content_client.</tt><tt class="descname">Configuration</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.Configuration" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Configuration</span></tt> class provides methods to configure the global
|
||
|
|
settings of the Content Library Service.</p>
|
||
|
|
<p>The configuration settings are used by the Content Library Service to
|
||
|
|
control the behavior of various operations.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.Configuration.get">
|
||
|
|
<tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.content_client.Configuration.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Retrieves the current configuration values.</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">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><tt class="xref py py-class docutils literal"><span class="pre">ConfigurationModel</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><tt class="xref py py-class docutils literal"><span class="pre">ConfigurationModel</span></tt></a> instance representing the
|
||
|
|
configuration of the Content Library Service.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">ContentLibrary.GetConfiguration</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.Configuration.update">
|
||
|
|
<tt class="descname">update</tt><big>(</big><em>model</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.Configuration.update" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Updates the configuration. The update is incremental. Any attribute in
|
||
|
|
the <a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><tt class="xref py py-class docutils literal"><span class="pre">ConfigurationModel</span></tt></a> class that is None will not be
|
||
|
|
modified. Note that this update method doesn’t guarantee an atomic
|
||
|
|
change of all the properties. In the case of a system crash or failure,
|
||
|
|
some of the properties could be left unchanged while others may be
|
||
|
|
updated.</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>model</strong> (<a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><tt class="xref py py-class docutils literal"><span class="pre">ConfigurationModel</span></tt></a>) – The <a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><tt class="xref py py-class docutils literal"><span class="pre">ConfigurationModel</span></tt></a> specifying the settings to update.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if one of the configuration properties is not within the proper
|
||
|
|
range.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">ContentLibrary.UpdateConfiguration</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content_client.ConfigurationModel">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content_client.</tt><tt class="descname">ConfigurationModel</tt><big>(</big><em>automatic_sync_enabled=None</em>, <em>automatic_sync_start_hour=None</em>, <em>automatic_sync_stop_hour=None</em>, <em>maximum_concurrent_item_syncs=None</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.ConfigurationModel" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ConfigurationModel</span></tt> class defines the global settings of the Content
|
||
|
|
Library Service.</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>automatic_sync_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – <p>Whether automatic synchronization is enabled.</p>
|
||
|
|
<p>When automatic synchronization is enabled, the Content Library
|
||
|
|
Service will automatically synchronize all subscribed libraries on
|
||
|
|
a daily basis. Subscribed libraries with the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.automatic_sync_enabled</span></tt>
|
||
|
|
flag turned on will be synchronized every hour between
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ConfigurationModel.automatic_sync_start_hour</span></tt> and
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ConfigurationModel.automatic_sync_stop_hour</span></tt>.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>automatic_sync_start_hour</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – The hour at which the automatic synchronization will start. This
|
||
|
|
value is between 0 (midnight) and 23 inclusive.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>automatic_sync_stop_hour</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – The hour at which the automatic synchronization will stop. Any
|
||
|
|
active synchronization operation will continue to run, however no
|
||
|
|
new synchronization operations will be triggered after the stop
|
||
|
|
hour. This value is between 0 (midnight) and 23 inclusive.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>maximum_concurrent_item_syncs</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – <p>The maximum allowed number of library items to synchronize
|
||
|
|
concurrently from remote libraries. This must be a positive number.
|
||
|
|
The service may not be able to guarantee the requested concurrency
|
||
|
|
if there is no available capacity.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>This setting is global across all subscribed libraries.</div></blockquote>
|
||
|
|
<p>This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content_client.Library">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content_client.</tt><tt class="descname">Library</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.Library" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Library</span></tt> class provides methods to manage and find
|
||
|
|
<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a> entities.</p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Library</span></tt> class provides support for generic functionality which can
|
||
|
|
be applied equally to all types of libraries. The functionality provided by
|
||
|
|
this class will not affect the properties specific to the type of library.
|
||
|
|
See also <a class="reference internal" href="#com.vmware.content_client.LocalLibrary" title="com.vmware.content_client.LocalLibrary"><tt class="xref py py-class docutils literal"><span class="pre">LocalLibrary</span></tt></a> and <a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary" title="com.vmware.content_client.SubscribedLibrary"><tt class="xref py py-class docutils literal"><span class="pre">SubscribedLibrary</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content_client.Library.FindSpec">
|
||
|
|
<em class="property">class </em><tt class="descname">FindSpec</tt><big>(</big><em>name=None</em>, <em>type=None</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.Library.FindSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>Specifies the properties that can be used as a filter to find libraries.
|
||
|
|
When multiple attributes are specified, all properties of the library must
|
||
|
|
match the specification.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Name of the library to search. The name is case-insensitive. See
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryModel.name</span></tt>.
|
||
|
|
If not specified any name will be searched.</li>
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel.LibraryType" title="com.vmware.content_client.LibraryModel.LibraryType"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel.LibraryType</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Library type to search. See <tt class="xref py py-attr docutils literal"><span class="pre">LibraryModel.type</span></tt>.
|
||
|
|
If not specified any library type will be searched.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content_client.Library.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Library.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'com.vmware.content.Library'</em><a class="headerlink" href="#com.vmware.content_client.Library.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Resource type for library.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.Library.find">
|
||
|
|
<tt class="descclassname">Library.</tt><tt class="descname">find</tt><big>(</big><em>spec</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.Library.find" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns a list of all the visible (as determined by authorization
|
||
|
|
policy) libraries matching the requested <a class="reference internal" href="#com.vmware.content_client.Library.FindSpec" title="com.vmware.content_client.Library.FindSpec"><tt class="xref py py-class docutils literal"><span class="pre">Library.FindSpec</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.content_client.Library.FindSpec" title="com.vmware.content_client.Library.FindSpec"><tt class="xref py py-class docutils literal"><span class="pre">Library.FindSpec</span></tt></a>) – Specification describing what properties to filter on.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.Library.list" title="com.vmware.content_client.Library.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.Library.list" title="com.vmware.content_client.Library.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of identifiers of all the visible libraries
|
||
|
|
matching the given <tt class="docutils literal"><span class="pre">spec</span></tt>.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if no properties are specified in the <tt class="docutils literal"><span class="pre">spec</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.Library.get">
|
||
|
|
<tt class="descclassname">Library.</tt><tt class="descname">get</tt><big>(</big><em>library_id</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.Library.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns a given <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the library to return.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a> instance with the specified
|
||
|
|
<tt class="docutils literal"><span class="pre">library_id</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the specified library does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
parameter <tt class="docutils literal"><span class="pre">library_id</span></tt> requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.Library.list">
|
||
|
|
<tt class="descclassname">Library.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.content_client.Library.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the identifiers of all libraries of any type in the Content
|
||
|
|
Library.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.Library.list" title="com.vmware.content_client.Library.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.Library.list" title="com.vmware.content_client.Library.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of all identifiers of all libraries in the
|
||
|
|
Content Library.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.Library.update">
|
||
|
|
<tt class="descclassname">Library.</tt><tt class="descname">update</tt><big>(</big><em>library_id</em>, <em>update_spec</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.Library.update" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Updates the properties of a library.</p>
|
||
|
|
<p>This is an incremental update to the library. Any attribute in the
|
||
|
|
<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a> class that is None will not be modified.</p>
|
||
|
|
<p>This method will only update the common properties for all library
|
||
|
|
types. This will not, for example, update the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryModel.publish_info</span></tt> of a local library, nor the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryModel.subscription_info</span></tt> of a subscribed library.
|
||
|
|
Specific properties are updated in <a class="reference internal" href="#com.vmware.content_client.LocalLibrary.update" title="com.vmware.content_client.LocalLibrary.update"><tt class="xref py py-func docutils literal"><span class="pre">LocalLibrary.update()</span></tt></a> and
|
||
|
|
<a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.update" title="com.vmware.content_client.SubscribedLibrary.update"><tt class="xref py py-func docutils literal"><span class="pre">SubscribedLibrary.update()</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the library to update.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</li>
|
||
|
|
<li><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a>) – Specification of the new property values to set on the library.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library associated with <tt class="docutils literal"><span class="pre">library_id</span></tt> does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="docutils literal"><span class="pre">update_spec</span></tt> is not valid.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">LibraryModel.version</span></tt> of <tt class="docutils literal"><span class="pre">update_spec</span></tt> is not equal
|
||
|
|
to the current version of the library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
parameter <tt class="docutils literal"><span class="pre">library_id</span></tt> requires <tt class="docutils literal"><span class="pre">ContentLibrary.UpdateLibrary</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content_client.LibraryModel">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content_client.</tt><tt class="descname">LibraryModel</tt><big>(</big><em>id=None</em>, <em>creation_time=None</em>, <em>description=None</em>, <em>last_modified_time=None</em>, <em>last_sync_time=None</em>, <em>name=None</em>, <em>storage_backings=None</em>, <em>type=None</em>, <em>optimization_info=None</em>, <em>version=None</em>, <em>publish_info=None</em>, <em>subscription_info=None</em>, <em>server_guid=None</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.LibraryModel" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a> class represents a Content Library resource
|
||
|
|
model.</p>
|
||
|
|
<p>A <tt class="docutils literal"><span class="pre">LibraryModel</span></tt> is a container for a set of items which represent a
|
||
|
|
usable set of files. The Content Library Service allows for multiple
|
||
|
|
libraries to be created with separate authorization and sharing policies.</p>
|
||
|
|
<p>Each <tt class="docutils literal"><span class="pre">LibraryModel</span></tt> is a container for a set of
|
||
|
|
<a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.ItemModel</span></tt></a> instances. Each item
|
||
|
|
is a logical object in a library, which may have multiple files.</p>
|
||
|
|
<p>A <tt class="docutils literal"><span class="pre">LibraryModel</span></tt> may be local or subscribed. A local library has its
|
||
|
|
source of truth about items within this Content Library Service. Items may
|
||
|
|
be added to or removed from the library. A local library may also be
|
||
|
|
private or published. When published, the library is exposed by a network
|
||
|
|
endpoint and can be used by another Content Library Service for
|
||
|
|
synchronization. A private local library cannot be used for
|
||
|
|
synchronization.</p>
|
||
|
|
<p>A subscribed library is a library which gets its source of truth from
|
||
|
|
another library that may be across a network in another Content Library
|
||
|
|
Service. A subscribed library may have a different name and metadata from
|
||
|
|
the library to which it subscribes, but the set of library items is always
|
||
|
|
the same as those in the source library. Library items cannot be manually
|
||
|
|
added to a subscribed library – they can only be added by adding new items
|
||
|
|
to the source library.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – An identifier which uniquely identifies this <tt class="docutils literal"><span class="pre">LibraryModel</span></tt>.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>. When methods return a value of this
|
||
|
|
class as a return value, the attribute will be an identifier for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will not
|
||
|
|
be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods.
|
||
|
|
It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>creation_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – The date and time when this library was created.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – A human-readable description for this library.
|
||
|
|
This attribute is optional for the <tt class="docutils literal"><span class="pre">create</span></tt> method. Leaving it
|
||
|
|
None during creation will result in an empty string value. It will
|
||
|
|
always be present in the result of a <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> method. It
|
||
|
|
is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method. Leaving it None during
|
||
|
|
update indicates that the description should be left unchanged.</li>
|
||
|
|
<li><strong>last_modified_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – <p>The date and time when this library was last updated.</p>
|
||
|
|
<p>This attribute is updated automatically when the library properties
|
||
|
|
are changed. This attribute is not affected by adding, removing, or
|
||
|
|
modifying a library item or its content within the library. Tagging
|
||
|
|
the library or syncing the subscribed library does not alter this
|
||
|
|
attribute.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>last_sync_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – <p>The date and time when this library was last synchronized.</p>
|
||
|
|
<p>This attribute applies only to subscribed libraries. It is updated
|
||
|
|
every time a synchronization is triggered on the library. The value
|
||
|
|
is None for a local library.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It is
|
||
|
|
optional in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods. It
|
||
|
|
is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <p>The name of the library.</p>
|
||
|
|
<p>A Library is identified by a human-readable name. Library names
|
||
|
|
cannot be undefined or an empty string. Names do not have to be
|
||
|
|
unique.
|
||
|
|
This attribute must be provided for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>storage_backings</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.StorageBacking" title="com.vmware.content.library_client.StorageBacking"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.StorageBacking</span></tt></a>) – <p>The list of storage backings which are available for this library.</p>
|
||
|
|
<p>A <a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.StorageBacking" title="com.vmware.content.library_client.StorageBacking"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.StorageBacking</span></tt></a> defines
|
||
|
|
a storage location which can be used to store files for the library
|
||
|
|
items in this library. Multiple storage locations are not currently
|
||
|
|
supported but may become supported in future releases.
|
||
|
|
This attribute must be provided for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel.LibraryType" title="com.vmware.content_client.LibraryModel.LibraryType"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel.LibraryType</span></tt></a>) – <p>The type (LOCAL, SUBSCRIBED) of this library.</p>
|
||
|
|
<p>This value can be used to determine what additional services and
|
||
|
|
information can be available for this library.
|
||
|
|
This attribute must be provided for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>optimization_info</strong> (<a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.OptimizationInfo" title="com.vmware.content.library_client.OptimizationInfo"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.OptimizationInfo</span></tt></a>) – Defines various optimizations and optimization parameters applied
|
||
|
|
to this library.
|
||
|
|
This attribute is optional for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It is
|
||
|
|
optional in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods. It
|
||
|
|
is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>version</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <p>A version number which is updated on metadata changes. This value
|
||
|
|
allows clients to detect concurrent updates and prevent accidental
|
||
|
|
clobbering of data.</p>
|
||
|
|
<p>This value represents a number which is incremented every time
|
||
|
|
library properties, such as name or description, are changed. It is
|
||
|
|
not incremented by changes to a library item within the library,
|
||
|
|
including adding or removing items. It is also not affected by
|
||
|
|
tagging the library.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the result of a <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> method. It
|
||
|
|
is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method. Leaving it None during
|
||
|
|
update indicates that you do not need to detect concurrent updates.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>publish_info</strong> (<a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.PublishInfo" title="com.vmware.content.library_client.PublishInfo"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.PublishInfo</span></tt></a>) – <p>Defines how this library is published so that it can be subscribed
|
||
|
|
to by a remote subscribed library.</p>
|
||
|
|
<p>The <a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.PublishInfo" title="com.vmware.content.library_client.PublishInfo"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.PublishInfo</span></tt></a> defines
|
||
|
|
where and how the metadata for this local library is accessible. A
|
||
|
|
local library is only published publically if
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">com.vmware.content.library_client.PublishInfo.published</span></tt> is
|
||
|
|
<tt class="docutils literal"><span class="pre">true</span></tt>.
|
||
|
|
This attribute is optional for the <tt class="docutils literal"><span class="pre">create</span></tt> and <tt class="docutils literal"><span class="pre">update</span></tt>
|
||
|
|
methods. If not specified during creation, the default is for the
|
||
|
|
library to not be published. If not specified during update, the
|
||
|
|
attribute is left unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>subscription_info</strong> (<a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.SubscriptionInfo" title="com.vmware.content.library_client.SubscriptionInfo"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.SubscriptionInfo</span></tt></a>) – <p>Defines the subscription behavior for this Library.</p>
|
||
|
|
<p>The <a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.SubscriptionInfo" title="com.vmware.content.library_client.SubscriptionInfo"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.SubscriptionInfo</span></tt></a>
|
||
|
|
defines how this subscribed library synchronizes to a remote
|
||
|
|
source. Setting the value will determine the remote source to which
|
||
|
|
the library synchronizes, and how. Changing the subscription will
|
||
|
|
result in synchronizing to a new source. If the new source differs
|
||
|
|
from the old one, the old library items and data will be lost.
|
||
|
|
Setting
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.automatic_sync_enabled</span></tt>
|
||
|
|
to false will halt subscription but will not remove existing cached
|
||
|
|
data.
|
||
|
|
This attribute is optional for the <tt class="docutils literal"><span class="pre">create</span></tt> and <tt class="docutils literal"><span class="pre">update</span></tt>
|
||
|
|
methods. If not specified during creation, a default will be
|
||
|
|
created without an active subscription. If not specified during
|
||
|
|
update, the attribute is left unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>server_guid</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The unique identifier of the vCenter server where the library
|
||
|
|
exists.
|
||
|
|
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.vcenter.VCenter</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.vcenter.VCenter</span></tt>.
|
||
|
|
This attribute is optional for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content_client.LibraryModel.LibraryType">
|
||
|
|
<em class="property">class </em><tt class="descname">LibraryType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.LibraryModel.LibraryType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LibraryModel.LibraryType</span></tt> class defines the type of a
|
||
|
|
<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a>.</p>
|
||
|
|
<p>The type of a library can be used to determine which additional services
|
||
|
|
can be performed with a library.</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">LibraryType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content_client.LibraryModel.LibraryType.LOCAL">
|
||
|
|
<tt class="descname">LOCAL</tt><em class="property"> = LibraryType(string=u'LOCAL')</em><a class="headerlink" href="#com.vmware.content_client.LibraryModel.LibraryType.LOCAL" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The library contents are defined and stored by the local Content Library
|
||
|
|
Service installation.</p>
|
||
|
|
<p>A local library can be retrieved and managed via the <a class="reference internal" href="#com.vmware.content_client.LocalLibrary" title="com.vmware.content_client.LocalLibrary"><tt class="xref py py-class docutils literal"><span class="pre">LocalLibrary</span></tt></a>.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content_client.LibraryModel.LibraryType.SUBSCRIBED">
|
||
|
|
<tt class="descname">SUBSCRIBED</tt><em class="property"> = LibraryType(string=u'SUBSCRIBED')</em><a class="headerlink" href="#com.vmware.content_client.LibraryModel.LibraryType.SUBSCRIBED" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The library synchronizes its items and content from another published
|
||
|
|
library.</p>
|
||
|
|
<p>A subscribed library can be retrieved and managed via the
|
||
|
|
<a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary" title="com.vmware.content_client.SubscribedLibrary"><tt class="xref py py-class docutils literal"><span class="pre">SubscribedLibrary</span></tt></a>.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content_client.LocalLibrary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content_client.</tt><tt class="descname">LocalLibrary</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.LocalLibrary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LocalLibrary</span></tt> class manages local libraries.</p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">LocalLibrary</span></tt> class provides support for creating and maintaining
|
||
|
|
local library instances. A local library may also use the <a class="reference internal" href="#com.vmware.content_client.Library" title="com.vmware.content_client.Library"><tt class="xref py py-class docutils literal"><span class="pre">Library</span></tt></a>
|
||
|
|
class to manage general library functionality.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.LocalLibrary.create">
|
||
|
|
<tt class="descname">create</tt><big>(</big><em>create_spec</em>, <em>client_token=None</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.LocalLibrary.create" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Creates a new local library.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>client_token</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – A unique token generated on the client for each creation request.
|
||
|
|
The token should be a universally unique identifier (UUID), for
|
||
|
|
example: <tt class="docutils literal"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></tt>. This token can
|
||
|
|
be used to guarantee idempotent creation.
|
||
|
|
If not specified creation is not idempotent.</li>
|
||
|
|
<li><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a>) – Specification for the new local library.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Identifier of the newly created <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a>.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="docutils literal"><span class="pre">create_spec</span></tt> is not valid.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="docutils literal"><span class="pre">client_token</span></tt> does not conform to the UUID format.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></tt>
|
||
|
|
if using multiple storage backings.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">ContentLibrary.CreateLocalLibrary</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.LocalLibrary.delete">
|
||
|
|
<tt class="descname">delete</tt><big>(</big><em>library_id</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.LocalLibrary.delete" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Deletes the specified local library.</p>
|
||
|
|
<p>Deleting a local library will remove the entry immediately and begin an
|
||
|
|
asynchronous task to remove all cached content for the library. If the
|
||
|
|
asynchronous task fails, file content may remain on the storage
|
||
|
|
backing. This content will require manual removal.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the local library to delete.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> is not a local library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
parameter <tt class="docutils literal"><span class="pre">library_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.DeleteLocalLibrary</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.LocalLibrary.get">
|
||
|
|
<tt class="descname">get</tt><big>(</big><em>library_id</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.LocalLibrary.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns a given local library.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the local library to return.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a> instance associated with <tt class="docutils literal"><span class="pre">library_id</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> is not a local library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
parameter <tt class="docutils literal"><span class="pre">library_id</span></tt> requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.LocalLibrary.list">
|
||
|
|
<tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.content_client.LocalLibrary.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the identifiers of all local libraries in the Content Library.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.LocalLibrary.list" title="com.vmware.content_client.LocalLibrary.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.LocalLibrary.list" title="com.vmware.content_client.LocalLibrary.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of identifiers of all local libraries in the
|
||
|
|
Content Library.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.LocalLibrary.update">
|
||
|
|
<tt class="descname">update</tt><big>(</big><em>library_id</em>, <em>update_spec</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.LocalLibrary.update" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Updates the properties of a local library.</p>
|
||
|
|
<p>This is an incremental update to the local library. Attributes that are
|
||
|
|
None in the update specification will be left unchanged.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the local library to update.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</li>
|
||
|
|
<li><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a>) – Specification of the new property values to set on the local
|
||
|
|
library.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> is not a local library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="docutils literal"><span class="pre">update_spec</span></tt> is not valid.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">LibraryModel.version</span></tt> of <tt class="docutils literal"><span class="pre">update_spec</span></tt> is not equal
|
||
|
|
to the current version of the library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
parameter <tt class="docutils literal"><span class="pre">library_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.UpdateLocalLibrary</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content_client.</tt><tt class="descname">SubscribedLibrary</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult">
|
||
|
|
<em class="property">class </em><tt class="descname">ProbeResult</tt><big>(</big><em>status=None</em>, <em>ssl_thumbprint=None</em>, <em>error_messages=None</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">SubscribedLibrary.ProbeResult</span></tt> class defines the subscription
|
||
|
|
information probe result. This describes whether using a given subscription
|
||
|
|
URL is successful or if there are access problems, such as SSL errors.</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>status</strong> (<a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status" title="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status"><tt class="xref py py-class docutils literal"><span class="pre">SubscribedLibrary.ProbeResult.Status</span></tt></a>) – The status of probe result. This will be one of SUCCESS,
|
||
|
|
INVALID_URL, TIMED_OUT, HOST_NOT_FOUND, RESOURCE_NOT_FOUND,
|
||
|
|
INVALID_CREDENTIALS, CERTIFICATE_ERROR, UNKNOWN_ERROR.</li>
|
||
|
|
<li><strong>ssl_thumbprint</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 SSL thumbprint for the remote endpoint.
|
||
|
|
An SSL thumbprint is only returned if the host is secured with
|
||
|
|
SSL/TLS.</li>
|
||
|
|
<li><strong>error_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>) – If the probe result is in an error status, this attribute will
|
||
|
|
contain the detailed error messages.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status">
|
||
|
|
<em class="property">class </em><tt class="descname">Status</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">SubscribedLibrary.ProbeResult.Status</span></tt> class defines the error status
|
||
|
|
constants for the probe result.</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">Status</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.CERTIFICATE_ERROR">
|
||
|
|
<tt class="descname">CERTIFICATE_ERROR</tt><em class="property"> = Status(string=u'CERTIFICATE_ERROR')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.CERTIFICATE_ERROR" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Indicates that the provided server certificate thumbprint in
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.ssl_thumbprint</span></tt>
|
||
|
|
is invalid. In this case, the returned null should be set in
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.ssl_thumbprint</span></tt>.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.HOST_NOT_FOUND">
|
||
|
|
<tt class="descname">HOST_NOT_FOUND</tt><em class="property"> = Status(string=u'HOST_NOT_FOUND')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.HOST_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Indicates that the host in the URL could not be found.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.INVALID_CREDENTIALS">
|
||
|
|
<tt class="descname">INVALID_CREDENTIALS</tt><em class="property"> = Status(string=u'INVALID_CREDENTIALS')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.INVALID_CREDENTIALS" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Indicates that the connection was rejected due to invalid credentials.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.INVALID_URL">
|
||
|
|
<tt class="descname">INVALID_URL</tt><em class="property"> = Status(string=u'INVALID_URL')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.INVALID_URL" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Indicates that the supplied URL was not valid.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.RESOURCE_NOT_FOUND">
|
||
|
|
<tt class="descname">RESOURCE_NOT_FOUND</tt><em class="property"> = Status(string=u'RESOURCE_NOT_FOUND')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.RESOURCE_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Indicates that the given resource at the URL was not found.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.SUCCESS">
|
||
|
|
<tt class="descname">SUCCESS</tt><em class="property"> = Status(string=u'SUCCESS')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.SUCCESS" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Indicates that the probe was successful.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.TIMED_OUT">
|
||
|
|
<tt class="descname">TIMED_OUT</tt><em class="property"> = Status(string=u'TIMED_OUT')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.TIMED_OUT" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Indicates that the probe timed out while attempting to connect to the URL.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.UNKNOWN_ERROR">
|
||
|
|
<tt class="descname">UNKNOWN_ERROR</tt><em class="property"> = Status(string=u'UNKNOWN_ERROR')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.UNKNOWN_ERROR" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Indicates an unspecified error different from the other error cases defined
|
||
|
|
in <a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status" title="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status"><tt class="xref py py-class docutils literal"><span class="pre">SubscribedLibrary.ProbeResult.Status</span></tt></a>.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.create">
|
||
|
|
<tt class="descclassname">SubscribedLibrary.</tt><tt class="descname">create</tt><big>(</big><em>create_spec</em>, <em>client_token=None</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.create" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Creates a new subscribed library.</p>
|
||
|
|
<p>Once created, the subscribed library will be empty. If the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">LibraryModel.subscription_info</span></tt> property is set, the Content
|
||
|
|
Library Service will attempt to synchronize to the remote source. This
|
||
|
|
is an asynchronous operation so the content of the published library
|
||
|
|
may not immediately appear.</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>) – Unique token generated on the client for each creation request. The
|
||
|
|
token should be a universally unique identifier (UUID), for
|
||
|
|
example: <tt class="docutils literal"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></tt>. This token can
|
||
|
|
be used to guarantee idempotent creation.
|
||
|
|
If not specified creation is not idempotent.</li>
|
||
|
|
<li><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a>) – Specification for the new subscribed library.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Identifier of the newly created subscribed library.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="docutils literal"><span class="pre">create_spec</span></tt> is not valid.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="docutils literal"><span class="pre">client_token</span></tt> does not conform to the UUID format.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></tt>
|
||
|
|
if using multiple storage backings.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if subscribing to a published library which cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.CreateSubscribedLibrary</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.delete">
|
||
|
|
<tt class="descclassname">SubscribedLibrary.</tt><tt class="descname">delete</tt><big>(</big><em>library_id</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.delete" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Deletes the specified subscribed library.</p>
|
||
|
|
<p>Deleting a subscribed library will remove the entry immediately and
|
||
|
|
begin an asynchronous task to remove all cached content for the
|
||
|
|
library. If the asynchronous task fails, file content may remain on the
|
||
|
|
storage backing. This content will require manual removal.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the subscribed library to delete.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the library referenced by <tt class="docutils literal"><span class="pre">library_id</span></tt> is not a subscribed
|
||
|
|
library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library referenced by <tt class="docutils literal"><span class="pre">library_id</span></tt> does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
parameter <tt class="docutils literal"><span class="pre">library_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.DeleteSubscribedLibrary</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.evict">
|
||
|
|
<tt class="descclassname">SubscribedLibrary.</tt><tt class="descname">evict</tt><big>(</big><em>library_id</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.evict" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Evicts the cached content of an on-demand subscribed library.</p>
|
||
|
|
<p>This method allows the cached content of a subscribed library to be
|
||
|
|
removed to free up storage capacity. This method will only work when a
|
||
|
|
subscribed library is synchronized on-demand.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the subscribed library whose content should be
|
||
|
|
evicted.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> is not a subscribed
|
||
|
|
library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> does not synchronize
|
||
|
|
on-demand.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
parameter <tt class="docutils literal"><span class="pre">library_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.EvictSubscribedLibrary</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.get">
|
||
|
|
<tt class="descclassname">SubscribedLibrary.</tt><tt class="descname">get</tt><big>(</big><em>library_id</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns a given subscribed library.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the subscribed library to return.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a> instance that corresponds to
|
||
|
|
<tt class="docutils literal"><span class="pre">library_id</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library associated with <tt class="docutils literal"><span class="pre">library_id</span></tt> does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the library associated with <tt class="docutils literal"><span class="pre">library_id</span></tt> is not a subscribed
|
||
|
|
library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
parameter <tt class="docutils literal"><span class="pre">library_id</span></tt> requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.list">
|
||
|
|
<tt class="descclassname">SubscribedLibrary.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the identifiers of all subscribed libraries in the Content
|
||
|
|
Library.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.list" title="com.vmware.content_client.SubscribedLibrary.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.list" title="com.vmware.content_client.SubscribedLibrary.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of identifiers of all subscribed libraries in the
|
||
|
|
Content Library.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.probe">
|
||
|
|
<tt class="descclassname">SubscribedLibrary.</tt><tt class="descname">probe</tt><big>(</big><em>subscription_info</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.probe" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Probes remote library subscription information, including URL, SSL
|
||
|
|
certificate and password. The resulting
|
||
|
|
<a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult" title="com.vmware.content_client.SubscribedLibrary.ProbeResult"><tt class="xref py py-class docutils literal"><span class="pre">SubscribedLibrary.ProbeResult</span></tt></a> class describes whether or not
|
||
|
|
the subscription configuration is successful.</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>subscription_info</strong> (<a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.SubscriptionInfo" title="com.vmware.content.library_client.SubscriptionInfo"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.SubscriptionInfo</span></tt></a>) – The subscription info to be probed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult" title="com.vmware.content_client.SubscribedLibrary.ProbeResult"><tt class="xref py py-class docutils literal"><span class="pre">SubscribedLibrary.ProbeResult</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The subscription info probe result.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">ContentLibrary.ProbeSubscription</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.sync">
|
||
|
|
<tt class="descclassname">SubscribedLibrary.</tt><tt class="descname">sync</tt><big>(</big><em>library_id</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.sync" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Forces the synchronization of the subscribed library.</p>
|
||
|
|
<p>Synchronizing a subscribed library forcefully with this method will
|
||
|
|
perform the same synchronization behavior as would run periodically for
|
||
|
|
the library. The
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.on_demand</span></tt>
|
||
|
|
setting is respected. Calling this method on a library that is already
|
||
|
|
in the process of synchronizing will have no effect.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the subscribed library to synchronize.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> is not a subscribed
|
||
|
|
library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if some parameter in the subscribed library subscription info is
|
||
|
|
invalid.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the published library cannot be contacted or found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
parameter <tt class="docutils literal"><span class="pre">library_id</span></tt> requires <tt class="docutils literal"><span class="pre">ContentLibrary.SyncLibrary</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.update">
|
||
|
|
<tt class="descclassname">SubscribedLibrary.</tt><tt class="descname">update</tt><big>(</big><em>library_id</em>, <em>update_spec</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.update" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Updates the properties of a subscribed library.</p>
|
||
|
|
<p>This is an incremental update to the subscribed library. Attributes
|
||
|
|
that are None in the update specification will be left unchanged.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>library_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the subscribed library to update.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt>.</li>
|
||
|
|
<li><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><tt class="xref py py-class docutils literal"><span class="pre">LibraryModel</span></tt></a>) – Specification of the new property values to set on the subscribed
|
||
|
|
library.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the library specified by <tt class="docutils literal"><span class="pre">library_id</span></tt> is not a subscribed
|
||
|
|
library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="docutils literal"><span class="pre">update_spec</span></tt> is not valid.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">LibraryModel.version</span></tt> of <tt class="docutils literal"><span class="pre">update_spec</span></tt> is not equal
|
||
|
|
to the current version of the library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the subscription info is being updated but the published library
|
||
|
|
cannot be contacted or found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.Library</span></tt> referenced by the
|
||
|
|
parameter <tt class="docutils literal"><span class="pre">library_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.UpdateSubscribedLibrary</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content_client.Type">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content_client.</tt><tt class="descname">Type</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.Type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Type</span></tt> class exposes the
|
||
|
|
<a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.ItemModel</span></tt></a> types that this
|
||
|
|
Content Library Service supports.</p>
|
||
|
|
<p>A library item has an optional type which can be specified with the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">com.vmware.content.library_client.ItemModel.type</span></tt> attribute. For
|
||
|
|
items with a type that is supported by a plugin, the Content Library
|
||
|
|
Service may understand the files which are part of the library item and can
|
||
|
|
produce metadata for the item.</p>
|
||
|
|
<p>In other cases, uploads may require a process in which one upload implies
|
||
|
|
subsequent uploads. For example, an Open Virtualization Format (OVF)
|
||
|
|
package is composed of an OVF descriptor file and the associated virtual
|
||
|
|
disk files. Uploading an OVF descriptor can enable the Content Library
|
||
|
|
Service to understand that the complete OVF package requires additional
|
||
|
|
disk files, and it can set up the transfers for the disks automatically by
|
||
|
|
adding the file entries for the disks when the OVF descriptor is uploaded.</p>
|
||
|
|
<p>When a type is not supported by a plugin, or the type is not specified, the
|
||
|
|
Content Library Service can handle a library item in a default way, without
|
||
|
|
adding metadata to the item or guiding the upload process.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content_client.Type.Info">
|
||
|
|
<em class="property">class </em><tt class="descname">Info</tt><big>(</big><em>description=None</em>, <em>name=None</em>, <em>type=None</em>, <em>vendor=None</em>, <em>version=None</em><big>)</big><a class="headerlink" href="#com.vmware.content_client.Type.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Type.Info</span></tt> class describes support for a specific type of data in an
|
||
|
|
<a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.ItemModel</span></tt></a>. The <tt class="docutils literal"><span class="pre">Type.Info</span></tt> can
|
||
|
|
be queried through the <a class="reference internal" href="#com.vmware.content_client.Type" title="com.vmware.content_client.Type"><tt class="xref py py-class docutils literal"><span class="pre">Type</span></tt></a> class. Type support describes plugins
|
||
|
|
in the Content Library which can provide metadata on library items and help
|
||
|
|
manage the transfer process by adding dependent files when a current file
|
||
|
|
is added.</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>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – A description of the type support offered by the plugin.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of the plugin which provides the type support.</li>
|
||
|
|
<li><strong>type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <p>The type which the plugin supports.</p>
|
||
|
|
<p>To upload a library item of the type supported by the plugin, the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">com.vmware.content.library_client.ItemModel.type</span></tt> attribute
|
||
|
|
of the item should be set to this value.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>vendor</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of the vendor who created the type support plugin.</li>
|
||
|
|
<li><strong>version</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The version number of the type support plugin.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content_client.Type.list">
|
||
|
|
<tt class="descclassname">Type.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.content_client.Type.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns a <a class="reference internal" href="#com.vmware.content_client.Type.list" title="com.vmware.content_client.Type.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.content_client.Type.Info" title="com.vmware.content_client.Type.Info"><tt class="xref py py-class docutils literal"><span class="pre">Type.Info</span></tt></a> instances which describe
|
||
|
|
the type support plugins in this Content Library.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.Type.list" title="com.vmware.content_client.Type.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.content_client.Type.Info" title="com.vmware.content_client.Type.Info"><tt class="xref py py-class docutils literal"><span class="pre">Type.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">The <a class="reference internal" href="#com.vmware.content_client.Type.list" title="com.vmware.content_client.Type.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.content_client.Type.Info" title="com.vmware.content_client.Type.Info"><tt class="xref py py-class docutils literal"><span class="pre">Type.Info</span></tt></a> instances which describe
|
||
|
|
the type support plugins in this Content Library.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">ContentLibrary.TypeIntrospection</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.vcenter_client">
|
||
|
|
<span id="com-vmware-vcenter-client-module"></span><h2>com.vmware.vcenter_client module<a class="headerlink" href="#module-com.vmware.vcenter_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">com.vmware.vcenter_client</span></tt> module provides classes for managing VMware
|
||
|
|
vSphere environments. The module is available starting in vSphere 6.5.</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Cluster">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter_client.</tt><tt class="descname">Cluster</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Cluster" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cluster</span></tt> class provides methods to manage clusters in the vCenter
|
||
|
|
Server.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Cluster.FilterSpec">
|
||
|
|
<em class="property">class </em><tt class="descname">FilterSpec</tt><big>(</big><em>clusters=None</em>, <em>names=None</em>, <em>folders=None</em>, <em>datacenters=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cluster.FilterSpec</span></tt> class contains attributes used to filter the
|
||
|
|
results when listing clusters (see <a class="reference internal" href="#com.vmware.vcenter_client.Cluster.list" title="com.vmware.vcenter_client.Cluster.list"><tt class="xref py py-func docutils literal"><span class="pre">Cluster.list()</span></tt></a>). If multiple
|
||
|
|
attributes are specified, only clusters matching all of the attributes
|
||
|
|
match the filter.</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>clusters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Identifiers of clusters that can match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">ClusterComputeResource</span></tt>. When methods return a value of this
|
||
|
|
class as a return value, the attribute will contain identifiers for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">ClusterComputeResource</span></tt>.
|
||
|
|
If None or empty, clusters with any identifier match the filter.</li>
|
||
|
|
<li><strong>names</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Names that clusters must have to match the filter (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Cluster.Info.name</span></tt>).
|
||
|
|
If None or empty, clusters with any name match the filter.</li>
|
||
|
|
<li><strong>folders</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Folders that must contain the cluster for the cluster to match the
|
||
|
|
filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">Folder</span></tt>.
|
||
|
|
If None or empty, clusters in any folder match the filter.</li>
|
||
|
|
<li><strong>datacenters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Datacenters that must contain the cluster for the cluster to match
|
||
|
|
the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datacenter</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">Datacenter</span></tt>.
|
||
|
|
If None or empty, clusters in any datacenter match the filter.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Cluster.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Cluster.</tt><tt class="descname">Info</tt><big>(</big><em>name=None</em>, <em>resource_pool=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cluster.Info</span></tt> class contains information about a cluster in vCenter
|
||
|
|
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>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of the cluster</li>
|
||
|
|
<li><strong>resource_pool</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the root resource pool of the cluster
|
||
|
|
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>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Cluster.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Cluster.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'ClusterComputeResource'</em><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The resource type for the vCenter Cluster</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Cluster.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Cluster.</tt><tt class="descname">Summary</tt><big>(</big><em>cluster=None</em>, <em>name=None</em>, <em>ha_enabled=None</em>, <em>drs_enabled=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cluster.Summary</span></tt> class contains commonly used information about a
|
||
|
|
cluster in vCenter 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>cluster</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the cluster.
|
||
|
|
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">ClusterComputeResource</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">ClusterComputeResource</span></tt>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the cluster.</li>
|
||
|
|
<li><strong>ha_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the vSphere HA feature is enabled for the
|
||
|
|
cluster.</li>
|
||
|
|
<li><strong>drs_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the vSphere DRS service is enabled for the
|
||
|
|
cluster.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Cluster.get">
|
||
|
|
<tt class="descclassname">Cluster.</tt><tt class="descname">get</tt><big>(</big><em>cluster</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Retrieves information about the cluster corresponding to <tt class="docutils literal"><span class="pre">cluster</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"><strong>cluster</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the cluster.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">ClusterComputeResource</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Cluster.Info" title="com.vmware.vcenter_client.Cluster.Info"><tt class="xref py py-class docutils literal"><span class="pre">Cluster.Info</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.vcenter_client.Cluster.Info" title="com.vmware.vcenter_client.Cluster.Info"><tt class="xref py py-class docutils literal"><span class="pre">Cluster.Info</span></tt></a> instances that corresponds to the
|
||
|
|
<tt class="docutils literal"><span class="pre">cluster</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if there is no cluster associated with <tt class="docutils literal"><span class="pre">cluster</span></tt> in the system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the session id is missing from the request or the corresponding
|
||
|
|
session object cannot be found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t not have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Cluster.list">
|
||
|
|
<tt class="descclassname">Cluster.</tt><tt class="descname">list</tt><big>(</big><em>filter=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
||
|
|
checks) clusters in vCenter matching the <a class="reference internal" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="com.vmware.vcenter_client.Cluster.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Cluster.FilterSpec</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="com.vmware.vcenter_client.Cluster.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Cluster.FilterSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Specification of matching clusters for which information should be
|
||
|
|
returned.
|
||
|
|
If None, the behavior is equivalent to a
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="com.vmware.vcenter_client.Cluster.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Cluster.FilterSpec</span></tt></a> with all attributes None which means
|
||
|
|
all clusters match the filter.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Cluster.list" title="com.vmware.vcenter_client.Cluster.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_client.Cluster.Summary" title="com.vmware.vcenter_client.Cluster.Summary"><tt class="xref py py-class docutils literal"><span class="pre">Cluster.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the clusters matching the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="com.vmware.vcenter_client.Cluster.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Cluster.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if more than 1000 clusters match the <a class="reference internal" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="com.vmware.vcenter_client.Cluster.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Cluster.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datacenter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter_client.</tt><tt class="descname">Datacenter</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Datacenter</span></tt> class provides methods to manage datacenters in the
|
||
|
|
vCenter Server.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descname">CreateSpec</tt><big>(</big><em>name=None</em>, <em>folder=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Datacenter.CreateSpec</span></tt> class defines the information used to create
|
||
|
|
a datacenter.</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>) – The name of the datacenter to be created.</li>
|
||
|
|
<li><strong>folder</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>) – Datacenter folder in which the new datacenter should be created.
|
||
|
|
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>.
|
||
|
|
This attribute is currently required. In the future, if this
|
||
|
|
attribute is None, the system will attempt to choose a suitable
|
||
|
|
folder for the datacenter; if a folder cannot be chosen, the
|
||
|
|
datacenter creation operation will fail.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.FilterSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Datacenter.</tt><tt class="descname">FilterSpec</tt><big>(</big><em>datacenters=None</em>, <em>names=None</em>, <em>folders=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Datacenter.FilterSpec</span></tt> class contains attributes used to filter the
|
||
|
|
results when listing datacenters (see <a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.list" title="com.vmware.vcenter_client.Datacenter.list"><tt class="xref py py-func docutils literal"><span class="pre">Datacenter.list()</span></tt></a>). If multiple
|
||
|
|
attributes are specified, only datacenters matching all of the attributes
|
||
|
|
match the filter.</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>datacenters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Identifiers of datacenters that can match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datacenter</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">Datacenter</span></tt>.
|
||
|
|
If None or empty, datacenters with any identifier match the filter.</li>
|
||
|
|
<li><strong>names</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Names that datacenters must have to match the filter (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Datacenter.Info.name</span></tt>).
|
||
|
|
If None or empty, datacenters with any name match the filter.</li>
|
||
|
|
<li><strong>folders</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Folders that must contain the datacenters for the datacenter to
|
||
|
|
match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">Folder</span></tt>.
|
||
|
|
If None or empty, datacenters in any folder match the filter.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Datacenter.</tt><tt class="descname">Info</tt><big>(</big><em>name=None</em>, <em>datastore_folder=None</em>, <em>host_folder=None</em>, <em>network_folder=None</em>, <em>vm_folder=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Datacenter.Info</span></tt> class contains information about a datacenter in
|
||
|
|
vCenter 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>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of the datacenter.</li>
|
||
|
|
<li><strong>datastore_folder</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The root datastore folder associated with the datacenter.
|
||
|
|
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>.</li>
|
||
|
|
<li><strong>host_folder</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The root host and cluster folder associated with the datacenter.
|
||
|
|
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>.</li>
|
||
|
|
<li><strong>network_folder</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The root network folder associated with the datacenter.
|
||
|
|
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>.</li>
|
||
|
|
<li><strong>vm_folder</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The root virtual machine folder associated with the datacenter.
|
||
|
|
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>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Datacenter.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'Datacenter'</em><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The resource type for the vCenter Datacenter</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Datacenter.</tt><tt class="descname">Summary</tt><big>(</big><em>datacenter=None</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Datacenter.Summary</span></tt> class contains commonly used information about a
|
||
|
|
datacenter in vCenter 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>datacenter</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the datacenter.
|
||
|
|
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">Datacenter</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">Datacenter</span></tt>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the datacenter.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.create">
|
||
|
|
<tt class="descclassname">Datacenter.</tt><tt class="descname">create</tt><big>(</big><em>spec</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.create" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Create a new datacenter in the vCenter inventory</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>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.CreateSpec" title="com.vmware.vcenter_client.Datacenter.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Datacenter.CreateSpec</span></tt></a>) – Specification for the new datacenter to be created.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The identifier of the newly created datacenter
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datacenter</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></tt>
|
||
|
|
if the datacenter with the same name is already present.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the datacenter name is empty or invalid as per the underlying
|
||
|
|
implementation.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the folder is not specified and the system cannot choose a
|
||
|
|
suitable one.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the datacenter folder cannot be found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.delete">
|
||
|
|
<tt class="descclassname">Datacenter.</tt><tt class="descname">delete</tt><big>(</big><em>datacenter</em>, <em>force=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.delete" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Delete an empty datacenter from the vCenter Server</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>datacenter</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the datacenter to be deleted.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datacenter</span></tt>.</li>
|
||
|
|
<li><strong>force</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – If true, delete the datacenter even if it is not empty.
|
||
|
|
If None a <tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></tt>
|
||
|
|
exception will be reported if the datacenter is not empty. This is
|
||
|
|
the equivalent of passing the value false.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if there is no datacenter associated with <tt class="docutils literal"><span class="pre">datacenter</span></tt> in the
|
||
|
|
system.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></tt>
|
||
|
|
if the datacenter associated with <tt class="docutils literal"><span class="pre">datacenter</span></tt> is not empty.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.get">
|
||
|
|
<tt class="descclassname">Datacenter.</tt><tt class="descname">get</tt><big>(</big><em>datacenter</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Retrieves information about the datacenter corresponding to
|
||
|
|
<tt class="docutils literal"><span class="pre">datacenter</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"><strong>datacenter</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the datacenter.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datacenter</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.Info" title="com.vmware.vcenter_client.Datacenter.Info"><tt class="xref py py-class docutils literal"><span class="pre">Datacenter.Info</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.Info" title="com.vmware.vcenter_client.Datacenter.Info"><tt class="xref py py-class docutils literal"><span class="pre">Datacenter.Info</span></tt></a> instances that corresponds to the
|
||
|
|
<tt class="docutils literal"><span class="pre">datacenter</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if there is no datacenter associated with <tt class="docutils literal"><span class="pre">datacenter</span></tt> in the
|
||
|
|
system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.list">
|
||
|
|
<tt class="descclassname">Datacenter.</tt><tt class="descname">list</tt><big>(</big><em>filter=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
||
|
|
checks) datacenters in vCenter matching the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="com.vmware.vcenter_client.Datacenter.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Datacenter.FilterSpec</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="com.vmware.vcenter_client.Datacenter.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Datacenter.FilterSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Specification of matching datacenters for which information should
|
||
|
|
be returned.
|
||
|
|
If None, the behavior is equivalent to a
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="com.vmware.vcenter_client.Datacenter.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Datacenter.FilterSpec</span></tt></a> with all attributes None which means
|
||
|
|
all datacenters match the filter.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.list" title="com.vmware.vcenter_client.Datacenter.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_client.Datacenter.Summary" title="com.vmware.vcenter_client.Datacenter.Summary"><tt class="xref py py-class docutils literal"><span class="pre">Datacenter.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the datacenters matching the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="com.vmware.vcenter_client.Datacenter.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Datacenter.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if more than 1000 datacenters match the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="com.vmware.vcenter_client.Datacenter.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Datacenter.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter_client.</tt><tt class="descname">Datastore</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datastore" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The Datastore class provides methods for manipulating a datastore.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.FilterSpec">
|
||
|
|
<em class="property">class </em><tt class="descname">FilterSpec</tt><big>(</big><em>datastores=None</em>, <em>names=None</em>, <em>types=None</em>, <em>folders=None</em>, <em>datacenters=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Datastore.FilterSpec</span></tt> class contains attributes used to filter the
|
||
|
|
results when listing datastores (see <a class="reference internal" href="#com.vmware.vcenter_client.Datastore.list" title="com.vmware.vcenter_client.Datastore.list"><tt class="xref py py-func docutils literal"><span class="pre">Datastore.list()</span></tt></a>). If multiple
|
||
|
|
attributes are specified, only datastores matching all of the attributes
|
||
|
|
match the filter.</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>datastores</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Identifiers of datastores that can match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">Datastore</span></tt>.
|
||
|
|
If None or empty, datastores with any identifier match the filter.</li>
|
||
|
|
<li><strong>names</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Names that datastores must have to match the filter (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Datastore.Info.name</span></tt>).
|
||
|
|
If None or empty, datastores with any name match the filter.</li>
|
||
|
|
<li><strong>types</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> of <a class="reference internal" href="#com.vmware.vcenter_client.Datastore.Type" title="com.vmware.vcenter_client.Datastore.Type"><tt class="xref py py-class docutils literal"><span class="pre">Datastore.Type</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Types that datastores must have to match the filter (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Datastore.Summary.type</span></tt>).
|
||
|
|
If None or empty, datastores with any type match the filter.</li>
|
||
|
|
<li><strong>folders</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Folders that must contain the datastore for the datastore to match
|
||
|
|
the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">Folder</span></tt>.
|
||
|
|
If None or empty, datastores in any folder match the filter.</li>
|
||
|
|
<li><strong>datacenters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Datacenters that must contain the datastore for the datastore to
|
||
|
|
match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datacenter</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">Datacenter</span></tt>.
|
||
|
|
If None or empty, datastores in any datacenter match the filter.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Datastore.</tt><tt class="descname">Info</tt><big>(</big><em>name=None</em>, <em>type=None</em>, <em>accessible=None</em>, <em>free_space=None</em>, <em>multiple_host_access=None</em>, <em>thin_provisioning_supported=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">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"><ul class="first last simple">
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the datastore.</li>
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.Type" title="com.vmware.vcenter_client.Datastore.Type"><tt class="xref py py-class docutils literal"><span class="pre">Datastore.Type</span></tt></a>) – Type (VMFS, NFS, NFS41, CIFS, VSAN, VFFS, VVOL) of the datastore.</li>
|
||
|
|
<li><strong>accessible</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Whether or not this datastore is accessible.</li>
|
||
|
|
<li><strong>free_space</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Available space of this datastore, in bytes.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>The server periodically updates this value.</div></blockquote>
|
||
|
|
<p>This attribute will be None if the available space of this
|
||
|
|
datastore is not known.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>multiple_host_access</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Whether or not ore than one host in the datacenter has been
|
||
|
|
configured with access to the datastore.</li>
|
||
|
|
<li><strong>thin_provisioning_supported</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Whether or not the datastore supports thin provisioning on a per
|
||
|
|
file basis. When thin provisioning is used, backing storage is
|
||
|
|
lazily allocated.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Datastore.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'Datastore'</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The resource type for the vCenter datastore</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Datastore.</tt><tt class="descname">Summary</tt><big>(</big><em>datastore=None</em>, <em>name=None</em>, <em>type=None</em>, <em>free_space=None</em>, <em>capacity=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Datastore.Summary</span></tt> class contains commonly used 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"><ul class="first last simple">
|
||
|
|
<li><strong>datastore</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the datastore.
|
||
|
|
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>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the datastore.</li>
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.Type" title="com.vmware.vcenter_client.Datastore.Type"><tt class="xref py py-class docutils literal"><span class="pre">Datastore.Type</span></tt></a>) – Type (VMFS, NFS, NFS41, CIFS, VSAN, VFFS, VVOL) of the datatore.</li>
|
||
|
|
<li><strong>free_space</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Available space of this datastore, in bytes.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>The server periodically updates this value.</div></blockquote>
|
||
|
|
<p>This attribute will be None if the available space of this
|
||
|
|
datastore is not known.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>capacity</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Capacity of this datastore, in bytes.</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>The server periodically updates this value.</div></blockquote>
|
||
|
|
<p>This attribute will be None if the capacity of this datastore is
|
||
|
|
not known.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Datastore.</tt><tt class="descname">Type</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Datastore.Type</span></tt> class defines the supported types of vCenter
|
||
|
|
datastores.</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_client.Datastore.Type.CIFS">
|
||
|
|
<tt class="descname">CIFS</tt><em class="property"> = Type(string=u'CIFS')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.CIFS" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Common Internet File System.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.NFS">
|
||
|
|
<tt class="descname">NFS</tt><em class="property"> = Type(string=u'NFS')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.NFS" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Network file system v3 (linux & esx servers only).</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.NFS41">
|
||
|
|
<tt class="descname">NFS41</tt><em class="property"> = Type(string=u'NFS41')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.NFS41" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Network file system v4.1 (linux & esx servers only).</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.VFFS">
|
||
|
|
<tt class="descname">VFFS</tt><em class="property"> = Type(string=u'VFFS')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.VFFS" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Flash Read Cache (ESX Server only).</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.VMFS">
|
||
|
|
<tt class="descname">VMFS</tt><em class="property"> = Type(string=u'VMFS')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.VMFS" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>VMware File System (ESX Server only).</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.VSAN">
|
||
|
|
<tt class="descname">VSAN</tt><em class="property"> = Type(string=u'VSAN')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.VSAN" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Virtual SAN (ESX Server only).</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.VVOL">
|
||
|
|
<tt class="descname">VVOL</tt><em class="property"> = Type(string=u'VVOL')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.VVOL" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>vSphere Virtual Volume (ESX Server only).</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.get">
|
||
|
|
<tt class="descclassname">Datastore.</tt><tt class="descname">get</tt><big>(</big><em>datastore</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Retrieves information about the datastore indicated by <tt class="docutils literal"><span class="pre">datastore</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"><strong>datastore</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the datastore for which information should be
|
||
|
|
retrieved.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datastore</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Datastore.Info" title="com.vmware.vcenter_client.Datastore.Info"><tt class="xref py py-class docutils literal"><span class="pre">Datastore.Info</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">information about the datastore.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the datastore indicated by <tt class="docutils literal"><span class="pre">datastore</span></tt> does not exist.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Datastore.list">
|
||
|
|
<tt class="descclassname">Datastore.</tt><tt class="descname">list</tt><big>(</big><em>filter=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
||
|
|
checks) datastores in vCenter matching the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="com.vmware.vcenter_client.Datastore.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Datastore.FilterSpec</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="com.vmware.vcenter_client.Datastore.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Datastore.FilterSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Specification of matching datastores for which information should
|
||
|
|
be returned.
|
||
|
|
If None, the behavior is equivalent to a
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="com.vmware.vcenter_client.Datastore.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Datastore.FilterSpec</span></tt></a> with all attributes None which means
|
||
|
|
all datastores match the filter.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Datastore.list" title="com.vmware.vcenter_client.Datastore.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_client.Datastore.Summary" title="com.vmware.vcenter_client.Datastore.Summary"><tt class="xref py py-class docutils literal"><span class="pre">Datastore.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the datastores matching the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="com.vmware.vcenter_client.Datastore.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Datastore.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">Datastore.FilterSpec.types</span></tt> attribute contains a
|
||
|
|
value that is not supported by the server.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">Datastore.FilterSpec.types</span></tt> attribute contains a
|
||
|
|
value that is not supported by the server.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if more than 1000 datastores match the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="com.vmware.vcenter_client.Datastore.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Datastore.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Folder">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter_client.</tt><tt class="descname">Folder</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Folder" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The Folder class provides methods for manipulating a vCenter Server folder.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Folder.FilterSpec">
|
||
|
|
<em class="property">class </em><tt class="descname">FilterSpec</tt><big>(</big><em>folders=None</em>, <em>names=None</em>, <em>type=None</em>, <em>parent_folders=None</em>, <em>datacenters=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Folder.FilterSpec</span></tt> class contains attributes used to filter the
|
||
|
|
results when listing folders (see <a class="reference internal" href="#com.vmware.vcenter_client.Folder.list" title="com.vmware.vcenter_client.Folder.list"><tt class="xref py py-func docutils literal"><span class="pre">Folder.list()</span></tt></a>). If multiple
|
||
|
|
attributes are specified, only folders matching all of the attributes match
|
||
|
|
the filter.</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>folders</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Identifiers of folders that can match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">Folder</span></tt>.
|
||
|
|
If None or empty, folders with any identifier match the filter.</li>
|
||
|
|
<li><strong>names</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Names that folders must have to match the filter (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Folder.Summary.name</span></tt>).
|
||
|
|
If None or empty, folders with any name match the filter.</li>
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Folder.Type" title="com.vmware.vcenter_client.Folder.Type"><tt class="xref py py-class docutils literal"><span class="pre">Folder.Type</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Type that folders must have to match the filter (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Folder.Summary.type</span></tt>).
|
||
|
|
If None, folders with any type match the filter.</li>
|
||
|
|
<li><strong>parent_folders</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Folders that must contain the folder for the folder to match the
|
||
|
|
filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">Folder</span></tt>.
|
||
|
|
If None or empty, folder in any folder match the filter.</li>
|
||
|
|
<li><strong>datacenters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Datacenters that must contain the folder for the folder to match
|
||
|
|
the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datacenter</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">Datacenter</span></tt>.
|
||
|
|
If None or empty, folder in any datacenter match the filter.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Folder.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Folder.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'Folder'</em><a class="headerlink" href="#com.vmware.vcenter_client.Folder.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The resource type for the vCenter folder</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Folder.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Folder.</tt><tt class="descname">Summary</tt><big>(</big><em>folder=None</em>, <em>name=None</em>, <em>type=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Folder.Summary</span></tt> class contains commonly used information about a
|
||
|
|
folder.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>folder</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the 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>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the vCenter Server folder.</li>
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Folder.Type" title="com.vmware.vcenter_client.Folder.Type"><tt class="xref py py-class docutils literal"><span class="pre">Folder.Type</span></tt></a>) – Type (DATACENTER, DATASTORE, HOST, NETWORK, VIRTUAL_MACHINE) of the
|
||
|
|
vCenter Server folder.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Folder.</tt><tt class="descname">Type</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Folder.Type</span></tt> class defines the type of a vCenter Server folder. The
|
||
|
|
type of a folder determines what what kinds of children can be contained in
|
||
|
|
the folder.</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_client.Folder.Type.DATACENTER">
|
||
|
|
<tt class="descname">DATACENTER</tt><em class="property"> = Type(string=u'DATACENTER')</em><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type.DATACENTER" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>A folder that can contain datacenters.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type.DATASTORE">
|
||
|
|
<tt class="descname">DATASTORE</tt><em class="property"> = Type(string=u'DATASTORE')</em><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type.DATASTORE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>A folder that can contain datastores.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type.HOST">
|
||
|
|
<tt class="descname">HOST</tt><em class="property"> = Type(string=u'HOST')</em><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type.HOST" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>A folder that can contain compute resources (hosts and clusters).</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type.NETWORK">
|
||
|
|
<tt class="descname">NETWORK</tt><em class="property"> = Type(string=u'NETWORK')</em><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type.NETWORK" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>A folder that can contain networkds.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type.VIRTUAL_MACHINE">
|
||
|
|
<tt class="descname">VIRTUAL_MACHINE</tt><em class="property"> = Type(string=u'VIRTUAL_MACHINE')</em><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type.VIRTUAL_MACHINE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>A folder that can contain virtual machines.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Folder.list">
|
||
|
|
<tt class="descclassname">Folder.</tt><tt class="descname">list</tt><big>(</big><em>filter=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Folder.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
||
|
|
checks) folders in vCenter matching the <a class="reference internal" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="com.vmware.vcenter_client.Folder.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Folder.FilterSpec</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="com.vmware.vcenter_client.Folder.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Folder.FilterSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Specification of matching folders for which information should be
|
||
|
|
returned.
|
||
|
|
If None, the behavior is equivalent to a <a class="reference internal" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="com.vmware.vcenter_client.Folder.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Folder.FilterSpec</span></tt></a>
|
||
|
|
with all attributes None which means all folders match the filter.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Folder.list" title="com.vmware.vcenter_client.Folder.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_client.Folder.Summary" title="com.vmware.vcenter_client.Folder.Summary"><tt class="xref py py-class docutils literal"><span class="pre">Folder.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the folders matching the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="com.vmware.vcenter_client.Folder.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Folder.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">Folder.FilterSpec.type</span></tt> attribute contains a value
|
||
|
|
that is not supported by the server.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if more than 1000 folders match the <a class="reference internal" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="com.vmware.vcenter_client.Folder.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Folder.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter_client.</tt><tt class="descname">Host</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Host" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Host</span></tt> class provides methods to manage hosts in the vCenter Server.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.ConnectionState">
|
||
|
|
<em class="property">class </em><tt class="descname">ConnectionState</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Host.ConnectionState" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Host.ConnectionState</span></tt> class defines the connection status of a host.</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">ConnectionState</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.ConnectionState.CONNECTED">
|
||
|
|
<tt class="descname">CONNECTED</tt><em class="property"> = ConnectionState(string=u'CONNECTED')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.ConnectionState.CONNECTED" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Host is connected to the vCenter Server</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.ConnectionState.DISCONNECTED">
|
||
|
|
<tt class="descname">DISCONNECTED</tt><em class="property"> = ConnectionState(string=u'DISCONNECTED')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.ConnectionState.DISCONNECTED" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Host is disconnected from the vCenter Server</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.ConnectionState.NOT_RESPONDING">
|
||
|
|
<tt class="descname">NOT_RESPONDING</tt><em class="property"> = ConnectionState(string=u'NOT_RESPONDING')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.ConnectionState.NOT_RESPONDING" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>VirtualCenter is not receiving heartbeats from the server. The state
|
||
|
|
automatically changes to connected once heartbeats are received again.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Host.</tt><tt class="descname">CreateSpec</tt><big>(</big><em>hostname=None</em>, <em>port=None</em>, <em>user_name=None</em>, <em>password=None</em>, <em>folder=None</em>, <em>thumbprint_verification=None</em>, <em>thumbprint=None</em>, <em>force_add=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Host.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Host.CreateSpec</span></tt> class defines the information used to create a
|
||
|
|
host.</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>hostname</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The IP address or DNS resolvable name of the host.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The port of the host.
|
||
|
|
If None, port 443 will be used.</li>
|
||
|
|
<li><strong>user_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The administrator account on the host.</li>
|
||
|
|
<li><strong>password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The password for the administrator account on the host.</li>
|
||
|
|
<li><strong>folder</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>) – Host and cluster folder in which the new standalone host should be
|
||
|
|
created.
|
||
|
|
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>.
|
||
|
|
This attribute is currently required. In the future, if this
|
||
|
|
attribute is None, the system will attempt to choose a suitable
|
||
|
|
folder for the host; if a folder cannot be chosen, the host
|
||
|
|
creation operation will fail.</li>
|
||
|
|
<li><strong>thumbprint_verification</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification" title="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification"><tt class="xref py py-class docutils literal"><span class="pre">Host.CreateSpec.ThumbprintVerification</span></tt></a>) – Type of host’s SSL certificate verification to be done.</li>
|
||
|
|
<li><strong>thumbprint</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The thumbprint of the SSL certificate, which the host is expected
|
||
|
|
to have. The thumbprint is always computed using the SHA1 hash and
|
||
|
|
is the string representation of that hash in the format:
|
||
|
|
xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx where,
|
||
|
|
‘x’ represents a hexadecimal digit.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">thumbprintVerification</span></tt> is
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.THUMBPRINT" title="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.THUMBPRINT"><tt class="xref py py-attr docutils literal"><span class="pre">Host.CreateSpec.ThumbprintVerification.THUMBPRINT</span></tt></a>.</li>
|
||
|
|
<li><strong>force_add</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Whether host should be added to the vCenter Server even if it is
|
||
|
|
being managed by another vCenter Server. The original vCenterServer
|
||
|
|
loses connection to the host.
|
||
|
|
If None, forceAdd is default to false.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification">
|
||
|
|
<em class="property">class </em><tt class="descname">ThumbprintVerification</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Host.CreateSpec.ThumbprintVerification</span></tt> class defines the thumbprint
|
||
|
|
verification schemes for a host’s SSL certificate.</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">ThumbprintVerification</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.NONE">
|
||
|
|
<tt class="descname">NONE</tt><em class="property"> = ThumbprintVerification(string=u'NONE')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.NONE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Accept the host’s thumbprint without verifying it.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.THUMBPRINT">
|
||
|
|
<tt class="descname">THUMBPRINT</tt><em class="property"> = ThumbprintVerification(string=u'THUMBPRINT')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.THUMBPRINT" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Host’s SSL certificate verified by checking its thumbprint against the
|
||
|
|
specified thumbprint.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.FilterSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Host.</tt><tt class="descname">FilterSpec</tt><big>(</big><em>hosts=None</em>, <em>names=None</em>, <em>folders=None</em>, <em>datacenters=None</em>, <em>standalone=None</em>, <em>clusters=None</em>, <em>connection_states=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Host.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Host.FilterSpec</span></tt> class contains attributes used to filter the
|
||
|
|
results when listing hosts (see <a class="reference internal" href="#com.vmware.vcenter_client.Host.list" title="com.vmware.vcenter_client.Host.list"><tt class="xref py py-func docutils literal"><span class="pre">Host.list()</span></tt></a>). If multiple attributes
|
||
|
|
are specified, only hosts matching all of the attributes match the filter.</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>hosts</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Identifiers of hosts that can match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">HostSystem</span></tt>.
|
||
|
|
If None or empty, hosts with any identifier match the filter.</li>
|
||
|
|
<li><strong>names</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Names that hosts must have to match the filter (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Host.Summary.name</span></tt>).
|
||
|
|
If None or empty, hosts with any name match the filter.</li>
|
||
|
|
<li><strong>folders</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Folders that must contain the hosts for the hosts to match the
|
||
|
|
filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">Folder</span></tt>.
|
||
|
|
If None or empty, hosts in any folder match the filter.</li>
|
||
|
|
<li><strong>datacenters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Datacenters that must contain the hosts for the hosts to match the
|
||
|
|
filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datacenter</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">Datacenter</span></tt>.
|
||
|
|
If None or empty, hosts in any datacenter match the filter.</li>
|
||
|
|
<li><strong>standalone</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – If true, only hosts that are not part of a cluster can match the
|
||
|
|
filter, and if false, only hosts that are are part of a cluster can
|
||
|
|
match the filter.
|
||
|
|
If None Hosts can match filter independent of whether they are part
|
||
|
|
of a cluster or not. If this field is true and
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Host.FilterSpec.clusters</span></tt> os not empty, no hosts will match
|
||
|
|
the filter.</li>
|
||
|
|
<li><strong>clusters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Clusters that must contain the hosts for the hosts to match the
|
||
|
|
filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">ClusterComputeResource</span></tt>. When methods return a value of this
|
||
|
|
class as a return value, the attribute will contain identifiers for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">ClusterComputeResource</span></tt>.
|
||
|
|
If None or empty, hosts in any cluster and hosts that are not in a
|
||
|
|
cluster match the filter. If this attribute is not empty and
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Host.FilterSpec.standalone</span></tt> is true, no hosts will match the
|
||
|
|
filter.</li>
|
||
|
|
<li><strong>connection_states</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> of <a class="reference internal" href="#com.vmware.vcenter_client.Host.ConnectionState" title="com.vmware.vcenter_client.Host.ConnectionState"><tt class="xref py py-class docutils literal"><span class="pre">Host.ConnectionState</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Connection states that a host must be in to match the filter (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Host.Summary.connection_state</span></tt>.
|
||
|
|
If None or empty, hosts in any connection state match the filter.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.PowerState">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Host.</tt><tt class="descname">PowerState</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Host.PowerState" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Host.PowerState</span></tt> class defines the power states of a host.</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">PowerState</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.PowerState.POWERED_OFF">
|
||
|
|
<tt class="descname">POWERED_OFF</tt><em class="property"> = PowerState(string=u'POWERED_OFF')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.PowerState.POWERED_OFF" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The host was specifically powered off by the user through vCenter server.
|
||
|
|
This state is not a cetain state, because after vCenter server issues the
|
||
|
|
command to power off the host, the host might crash, or kill all the
|
||
|
|
processes but fail to power off.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.PowerState.POWERED_ON">
|
||
|
|
<tt class="descname">POWERED_ON</tt><em class="property"> = PowerState(string=u'POWERED_ON')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.PowerState.POWERED_ON" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The host is powered on. A host that is entering standby mode is also in
|
||
|
|
this state.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.PowerState.STANDBY">
|
||
|
|
<tt class="descname">STANDBY</tt><em class="property"> = PowerState(string=u'STANDBY')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.PowerState.STANDBY" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The host was specifically put in standby mode, either explicitly by the
|
||
|
|
user, or automatically by DPM. This state is not a cetain state, because
|
||
|
|
after VirtualCenter issues the command to put the host in standby state,
|
||
|
|
the host might crash, or kill all the processes but fail to enter standby
|
||
|
|
mode. A host that is exiting standby mode is also in this state.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Host.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'HostSystem'</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The resource type for the vCenter Host.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Host.</tt><tt class="descname">Summary</tt><big>(</big><em>host=None</em>, <em>name=None</em>, <em>connection_state=None</em>, <em>power_state=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Host.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Host.Summary</span></tt> class contains commonly used information about a host
|
||
|
|
in vCenter 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>host</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the host.
|
||
|
|
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>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the host.</li>
|
||
|
|
<li><strong>connection_state</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Host.ConnectionState" title="com.vmware.vcenter_client.Host.ConnectionState"><tt class="xref py py-class docutils literal"><span class="pre">Host.ConnectionState</span></tt></a>) – Connection status of the host</li>
|
||
|
|
<li><strong>power_state</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Host.PowerState" title="com.vmware.vcenter_client.Host.PowerState"><tt class="xref py py-class docutils literal"><span class="pre">Host.PowerState</span></tt></a>) – Power state of the host
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">connectionState</span></tt> is <a class="reference internal" href="#com.vmware.vcenter_client.Host.ConnectionState.CONNECTED" title="com.vmware.vcenter_client.Host.ConnectionState.CONNECTED"><tt class="xref py py-attr docutils literal"><span class="pre">Host.ConnectionState.CONNECTED</span></tt></a>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.connect">
|
||
|
|
<tt class="descclassname">Host.</tt><tt class="descname">connect</tt><big>(</big><em>host</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Host.connect" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Connect to the host corresponding to <tt class="docutils literal"><span class="pre">host</span></tt> previously added to the
|
||
|
|
vCenter server.</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>host</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the host to be reconnected.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">HostSystem</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></tt>
|
||
|
|
if the host associated with <tt class="docutils literal"><span class="pre">host</span></tt> is already connected.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if there is no host associated with <tt class="docutils literal"><span class="pre">host</span></tt> in the system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.create">
|
||
|
|
<tt class="descclassname">Host.</tt><tt class="descname">create</tt><big>(</big><em>spec</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Host.create" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Add a new standalone host in the vCenter inventory. The newly connected
|
||
|
|
host will be in connected state. The vCenter Server will verify the SSL
|
||
|
|
certificate before adding the host to its inventory. In the case where
|
||
|
|
the SSL certificate cannot be verified because the Certificate
|
||
|
|
Authority is not recognized or the certificate is self signed, the
|
||
|
|
vCenter Server will fall back to thumbprint verification mode as
|
||
|
|
defined by <a class="reference internal" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification" title="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification"><tt class="xref py py-class docutils literal"><span class="pre">Host.CreateSpec.ThumbprintVerification</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Host.CreateSpec" title="com.vmware.vcenter_client.Host.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Host.CreateSpec</span></tt></a>) – Specification for the new host to be created.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The newly created identifier of the host in vCenter.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">HostSystem</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></tt>
|
||
|
|
if the host with the same name is already present.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if installation of VirtualCenter agent on a host fails.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the host name is invalid.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the host folder is invalid.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the SSL thumbprint specified is invalid.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt>
|
||
|
|
if the host folder id does not support vSphere compute resource as
|
||
|
|
its children type.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></tt>
|
||
|
|
if the host is already being managed by another vCenter Server</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if there are not enough licenses to add the host.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user name or password for the administration account on the
|
||
|
|
host are invalid.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></tt>
|
||
|
|
if the software version on the host is not supported.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.delete">
|
||
|
|
<tt class="descclassname">Host.</tt><tt class="descname">delete</tt><big>(</big><em>host</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Host.delete" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Remove a standalone host from the vCenter Server.</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>host</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the host to be deleted.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">HostSystem</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if there is no host associated with <tt class="docutils literal"><span class="pre">host</span></tt> in the system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></tt>
|
||
|
|
if the host associated with <tt class="docutils literal"><span class="pre">host</span></tt> is in a vCenter cluster</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.disconnect">
|
||
|
|
<tt class="descclassname">Host.</tt><tt class="descname">disconnect</tt><big>(</big><em>host</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Host.disconnect" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Disconnect the host corresponding to <tt class="docutils literal"><span class="pre">host</span></tt> from the vCenter server</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>host</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the host to be disconnected.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">HostSystem</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></tt>
|
||
|
|
if the host associated with <tt class="docutils literal"><span class="pre">host</span></tt> is already disconnected.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if there is no host associated with <tt class="docutils literal"><span class="pre">host</span></tt> in the system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Host.list">
|
||
|
|
<tt class="descclassname">Host.</tt><tt class="descname">list</tt><big>(</big><em>filter=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Host.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
||
|
|
checks) hosts in vCenter matching the <a class="reference internal" href="#com.vmware.vcenter_client.Host.FilterSpec" title="com.vmware.vcenter_client.Host.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Host.FilterSpec</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Host.FilterSpec" title="com.vmware.vcenter_client.Host.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Host.FilterSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Specification of matching hosts for which information should be
|
||
|
|
returned.
|
||
|
|
If None, the behavior is equivalent to a <a class="reference internal" href="#com.vmware.vcenter_client.Host.FilterSpec" title="com.vmware.vcenter_client.Host.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Host.FilterSpec</span></tt></a>
|
||
|
|
with all attributes None which means all hosts match the filter.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Host.list" title="com.vmware.vcenter_client.Host.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_client.Host.Summary" title="com.vmware.vcenter_client.Host.Summary"><tt class="xref py py-class docutils literal"><span class="pre">Host.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the hosts matching the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Host.FilterSpec" title="com.vmware.vcenter_client.Host.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Host.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">Host.FilterSpec.connection_states</span></tt> attribute contains
|
||
|
|
a value that is not supported by the server.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if more than 1000 hosts match the <a class="reference internal" href="#com.vmware.vcenter_client.Host.FilterSpec" title="com.vmware.vcenter_client.Host.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Host.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Network">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter_client.</tt><tt class="descname">Network</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Network" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The Network class provides methods for manipulating a vCenter Server
|
||
|
|
network.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Network.FilterSpec">
|
||
|
|
<em class="property">class </em><tt class="descname">FilterSpec</tt><big>(</big><em>networks=None</em>, <em>names=None</em>, <em>types=None</em>, <em>folders=None</em>, <em>datacenters=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Network.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Network.FilterSpec</span></tt> class contains attributes used to filter the
|
||
|
|
results when listing networks (see <a class="reference internal" href="#com.vmware.vcenter_client.Network.list" title="com.vmware.vcenter_client.Network.list"><tt class="xref py py-func docutils literal"><span class="pre">Network.list()</span></tt></a>). If multiple
|
||
|
|
attributes are specified, only networks matching all of the attributes
|
||
|
|
match the filter.</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>networks</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Identifiers of networks that can match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 attribute will contain identifiers for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">Network</span></tt>.
|
||
|
|
If None or empty, networks with any identifier match the filter.</li>
|
||
|
|
<li><strong>names</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Names that networks must have to match the filter (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Network.Summary.name</span></tt>).
|
||
|
|
If None or empty, networks with any name match the filter.</li>
|
||
|
|
<li><strong>types</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> of <a class="reference internal" href="#com.vmware.vcenter_client.Network.Type" title="com.vmware.vcenter_client.Network.Type"><tt class="xref py py-class docutils literal"><span class="pre">Network.Type</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Types that networks must have to match the filter (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Network.Summary.type</span></tt>).
|
||
|
|
If None, networks with any type match the filter.</li>
|
||
|
|
<li><strong>folders</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Folders that must contain the network for the network to match the
|
||
|
|
filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">Folder</span></tt>.
|
||
|
|
If None or empty, networks in any folder match the filter.</li>
|
||
|
|
<li><strong>datacenters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Datacenters that must contain the network for the network to match
|
||
|
|
the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datacenter</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">Datacenter</span></tt>.
|
||
|
|
If None or empty, networks in any datacenter match the filter.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Network.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Network.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'Network'</em><a class="headerlink" href="#com.vmware.vcenter_client.Network.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The resource type for the vCenter network</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Network.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Network.</tt><tt class="descname">Summary</tt><big>(</big><em>network=None</em>, <em>name=None</em>, <em>type=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Network.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Network.Summary</span></tt> class contains commonly used information about a
|
||
|
|
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"><ul class="first last simple">
|
||
|
|
<li><strong>network</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the network.
|
||
|
|
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">Network</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">Network</span></tt>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the network.</li>
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Network.Type" title="com.vmware.vcenter_client.Network.Type"><tt class="xref py py-class docutils literal"><span class="pre">Network.Type</span></tt></a>) – Type (STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP, OPAQUE_NETWORK) of
|
||
|
|
the vCenter Server network.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.Network.Type">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Network.</tt><tt class="descname">Type</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Network.Type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Network.Type</span></tt> class defines the type of a vCenter Server network.
|
||
|
|
The type of a network can be used to determine what features it supports
|
||
|
|
and which APIs can be used to find more information about the network or
|
||
|
|
change its configuration.</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_client.Network.Type.DISTRIBUTED_PORTGROUP">
|
||
|
|
<tt class="descname">DISTRIBUTED_PORTGROUP</tt><em class="property"> = Type(string=u'DISTRIBUTED_PORTGROUP')</em><a class="headerlink" href="#com.vmware.vcenter_client.Network.Type.DISTRIBUTED_PORTGROUP" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>XXX: vCenter based (create and managed through vCenter)</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Network.Type.OPAQUE_NETWORK">
|
||
|
|
<tt class="descname">OPAQUE_NETWORK</tt><em class="property"> = Type(string=u'OPAQUE_NETWORK')</em><a class="headerlink" href="#com.vmware.vcenter_client.Network.Type.OPAQUE_NETWORK" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>A network for whose configuration is managed outside of vSphere. The
|
||
|
|
identifer and name of the network is made available through vSphere so that
|
||
|
|
host and virtual machine virtual ethernet devices can connect to them.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.Network.Type.STANDARD_PORTGROUP">
|
||
|
|
<tt class="descname">STANDARD_PORTGROUP</tt><em class="property"> = Type(string=u'STANDARD_PORTGROUP')</em><a class="headerlink" href="#com.vmware.vcenter_client.Network.Type.STANDARD_PORTGROUP" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>XXX: ESX based (created and managed on ESX)</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.Network.list">
|
||
|
|
<tt class="descclassname">Network.</tt><tt class="descname">list</tt><big>(</big><em>filter=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.Network.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
||
|
|
checks) networks in vCenter matching the <a class="reference internal" href="#com.vmware.vcenter_client.Network.FilterSpec" title="com.vmware.vcenter_client.Network.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Network.FilterSpec</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Network.FilterSpec" title="com.vmware.vcenter_client.Network.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Network.FilterSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Specification of matching networks for which information should be
|
||
|
|
returned.
|
||
|
|
If None, the behavior is equivalent to a
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Network.FilterSpec" title="com.vmware.vcenter_client.Network.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Network.FilterSpec</span></tt></a> with all attributes None which means
|
||
|
|
all networks match the filter.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Network.list" title="com.vmware.vcenter_client.Network.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_client.Network.Summary" title="com.vmware.vcenter_client.Network.Summary"><tt class="xref py py-class docutils literal"><span class="pre">Network.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the networks matching the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Network.FilterSpec" title="com.vmware.vcenter_client.Network.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Network.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">Network.FilterSpec.types</span></tt> attribute contains a value
|
||
|
|
that is not supported by the server.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if more than 1000 networks match the <a class="reference internal" href="#com.vmware.vcenter_client.Network.FilterSpec" title="com.vmware.vcenter_client.Network.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">Network.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter_client.</tt><tt class="descname">ResourcePool</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The ResourcePool class provides methods for manipulating a vCenter Server
|
||
|
|
resource pool.</p>
|
||
|
|
<p>This class does not include virtual appliances in the inventory of resource
|
||
|
|
pools even though part of the behavior of a virtual appliance is to act
|
||
|
|
like a resource pool.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.FilterSpec">
|
||
|
|
<em class="property">class </em><tt class="descname">FilterSpec</tt><big>(</big><em>resource_pools=None</em>, <em>names=None</em>, <em>parent_resource_pools=None</em>, <em>datacenters=None</em>, <em>hosts=None</em>, <em>clusters=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ResourcePool.FilterSpec</span></tt> class contains attributes used to filter
|
||
|
|
the results when listing resource pools (see <a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.list" title="com.vmware.vcenter_client.ResourcePool.list"><tt class="xref py py-func docutils literal"><span class="pre">ResourcePool.list()</span></tt></a>). If
|
||
|
|
multiple attributes are specified, only resource pools matching all of the
|
||
|
|
attributes match the filter.</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_pools</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Identifiers of resource pools that can match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">ResourcePool</span></tt>.
|
||
|
|
If None or empty, resource pools with any identifier match the
|
||
|
|
filter.</li>
|
||
|
|
<li><strong>names</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Names that resource pools must have to match the filter (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">ResourcePool.Info.name</span></tt>).
|
||
|
|
If None or empty, resource pools with any name match the filter.</li>
|
||
|
|
<li><strong>parent_resource_pools</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Resource pools that must contain the resource pool for the resource
|
||
|
|
pool to match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">ResourcePool</span></tt>.
|
||
|
|
If None or empty, resource pools in any resource pool match the
|
||
|
|
filter.</li>
|
||
|
|
<li><strong>datacenters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Datacenters that must contain the resource pool for the resource
|
||
|
|
pool to match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datacenter</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">Datacenter</span></tt>.
|
||
|
|
If None or empty, resource pools in any datacenter match the
|
||
|
|
filter.</li>
|
||
|
|
<li><strong>hosts</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Hosts that must contain the resource pool for the resource pool to
|
||
|
|
match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">HostSystem</span></tt>.
|
||
|
|
If None or empty, resource pools in any host match the filter.</li>
|
||
|
|
<li><strong>clusters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Clusters that must contain the resource pool for the resource pool
|
||
|
|
to match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">ClusterComputeResource</span></tt>. When methods return a value of this
|
||
|
|
class as a return value, the attribute will contain identifiers for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">ClusterComputeResource</span></tt>.
|
||
|
|
If None or empty, resource pools in any cluster match the filter.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">ResourcePool.</tt><tt class="descname">Info</tt><big>(</big><em>name=None</em>, <em>resource_pools=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ResourcePool.Info</span></tt> class contains information about a resource pool.</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>) – Name of the vCenter Server resource pool.</li>
|
||
|
|
<li><strong>resource_pools</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifiers of the child resource pools contained in this resource
|
||
|
|
pool.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">ResourcePool</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">ResourcePool.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'ResourcePool'</em><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The resource type for the vCenter resource pool</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">ResourcePool.</tt><tt class="descname">Summary</tt><big>(</big><em>resource_pool=None</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ResourcePool.Summary</span></tt> class contains commonly used information about
|
||
|
|
a resource pool in vCenter 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>resource_pool</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the resource pool.
|
||
|
|
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>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the resource pool.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.get">
|
||
|
|
<tt class="descclassname">ResourcePool.</tt><tt class="descname">get</tt><big>(</big><em>resource_pool</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Retrieves information about the resource pool indicated by
|
||
|
|
<tt class="docutils literal"><span class="pre">resource_pool</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"><strong>resource_pool</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the resource pool for which information should be
|
||
|
|
retrieved.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">ResourcePool</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.Info" title="com.vmware.vcenter_client.ResourcePool.Info"><tt class="xref py py-class docutils literal"><span class="pre">ResourcePool.Info</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">information about the resource pool.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the resource pool indicated by <tt class="docutils literal"><span class="pre">resource_pool</span></tt> does not exist.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.list">
|
||
|
|
<tt class="descclassname">ResourcePool.</tt><tt class="descname">list</tt><big>(</big><em>filter=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
||
|
|
checks) resource pools in vCenter matching the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.FilterSpec" title="com.vmware.vcenter_client.ResourcePool.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">ResourcePool.FilterSpec</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.FilterSpec" title="com.vmware.vcenter_client.ResourcePool.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">ResourcePool.FilterSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Specification of matching resource pools for which information
|
||
|
|
should be returned.
|
||
|
|
If None, the behavior is equivalent to a
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.FilterSpec" title="com.vmware.vcenter_client.ResourcePool.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">ResourcePool.FilterSpec</span></tt></a> with all attributes None which
|
||
|
|
means all resource pools match the filter.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.list" title="com.vmware.vcenter_client.ResourcePool.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_client.ResourcePool.Summary" title="com.vmware.vcenter_client.ResourcePool.Summary"><tt class="xref py py-class docutils literal"><span class="pre">ResourcePool.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the resource pools matching the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.FilterSpec" title="com.vmware.vcenter_client.ResourcePool.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">ResourcePool.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if more than 1000 resource pools match the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.FilterSpec" title="com.vmware.vcenter_client.ResourcePool.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">ResourcePool.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.VM">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter_client.</tt><tt class="descname">VM</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.VM" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">VM</span></tt> class provides methods for managing the lifecycle of a virtual
|
||
|
|
machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.VM.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descname">CreateSpec</tt><big>(</big><em>guest_os=None</em>, <em>name=None</em>, <em>placement=None</em>, <em>hardware_version=None</em>, <em>boot=None</em>, <em>boot_devices=None</em>, <em>cpu=None</em>, <em>memory=None</em>, <em>disks=None</em>, <em>nics=None</em>, <em>cdroms=None</em>, <em>floppies=None</em>, <em>parallel_ports=None</em>, <em>serial_ports=None</em>, <em>sata_adapters=None</em>, <em>scsi_adapters=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.VM.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>Document-based creation spec.</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>guest_os</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.GuestOS" title="com.vmware.vcenter.vm_client.GuestOS"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm_client.GuestOS</span></tt></a>) – Guest OS.</li>
|
||
|
|
<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>) – Virtual machine name.
|
||
|
|
If None, a default name will be generated by the server.</li>
|
||
|
|
<li><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.PlacementSpec" title="com.vmware.vcenter_client.VM.PlacementSpec"><tt class="xref py py-class docutils literal"><span class="pre">VM.PlacementSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Virtual machine placement information.
|
||
|
|
This attribute is currently required. In the future, if this
|
||
|
|
attribute is None, the system will attempt to choose suitable
|
||
|
|
resources on which to place the virtual machine.</li>
|
||
|
|
<li><strong>hardware_version</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.Hardware.Version" title="com.vmware.vcenter.vm_client.Hardware.Version"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm_client.Hardware.Version</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Virtual hardware version.
|
||
|
|
If None, defaults to the most recent version supported by the
|
||
|
|
server.</li>
|
||
|
|
<li><strong>boot</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Boot.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Boot.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Boot.CreateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Boot configuration.
|
||
|
|
If None, guest-specific default values will be used.</li>
|
||
|
|
<li><strong>boot_devices</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#com.vmware.vcenter.vm.hardware.boot_client.Device.EntryCreateSpec" title="com.vmware.vcenter.vm.hardware.boot_client.Device.EntryCreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.boot_client.Device.EntryCreateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Boot device configuration.
|
||
|
|
If None, a server-specific boot sequence will be used.</li>
|
||
|
|
<li><strong>cpu</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – CPU configuration.
|
||
|
|
If None, guest-specific default values will be used.</li>
|
||
|
|
<li><strong>memory</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Memory configuration.
|
||
|
|
If None, guest-specific default values will be used.</li>
|
||
|
|
<li><strong>disks</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – List of disks.
|
||
|
|
If None, a single blank virtual disk of a guest-specific size will
|
||
|
|
be created on the same storage as the virtual machine
|
||
|
|
configuration, and will use a guest-specific host bus adapter type.
|
||
|
|
If the guest-specific size is 0, no virtual disk will be created.</li>
|
||
|
|
<li><strong>nics</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – List of Ethernet adapters.
|
||
|
|
If None, no Ethernet adapters will be created.</li>
|
||
|
|
<li><strong>cdroms</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – List of CD-ROMs.
|
||
|
|
If None, no CD-ROM devices will be created.</li>
|
||
|
|
<li><strong>floppies</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – List of floppy drives.
|
||
|
|
If None, no floppy drives will be created.</li>
|
||
|
|
<li><strong>parallel_ports</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – List of parallel ports.
|
||
|
|
If None, no parallel ports will be created.</li>
|
||
|
|
<li><strong>serial_ports</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – List of serial ports.
|
||
|
|
If None, no serial ports will be created.</li>
|
||
|
|
<li><strong>sata_adapters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec" title="com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – List of SATA adapters.
|
||
|
|
If None, any adapters necessary to connect the virtual machine’s
|
||
|
|
storage devices will be created; this includes any devices that
|
||
|
|
explicitly specify a SATA host bus adapter, as well as any devices
|
||
|
|
that do not specify a host bus adapter if the guest’s preferred
|
||
|
|
adapter type is SATA.</li>
|
||
|
|
<li><strong>scsi_adapters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.CreateSpec" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client.Scsi.CreateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – List of SCSI adapters.
|
||
|
|
If None, any adapters necessary to connect the virtual machine’s
|
||
|
|
storage devices will be created; this includes any devices that
|
||
|
|
explicitly specify a SCSI host bus adapter, as well as any devices
|
||
|
|
that do not specify a host bus adapter if the guest’s preferred
|
||
|
|
adapter type is SCSI. The type of the SCSI adapter will be a
|
||
|
|
guest-specific default type.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.VM.FilterSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">VM.</tt><tt class="descname">FilterSpec</tt><big>(</big><em>vms=None</em>, <em>names=None</em>, <em>folders=None</em>, <em>datacenters=None</em>, <em>hosts=None</em>, <em>clusters=None</em>, <em>resource_pools=None</em>, <em>power_states=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.VM.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">VM.FilterSpec</span></tt> class contains attributes used to filter the results
|
||
|
|
when listing virtual machines (see <a class="reference internal" href="#com.vmware.vcenter_client.VM.list" title="com.vmware.vcenter_client.VM.list"><tt class="xref py py-func docutils literal"><span class="pre">VM.list()</span></tt></a>). If multiple attributes
|
||
|
|
are specified, only virtual machines matching all of the attributes match
|
||
|
|
the filter.</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>vms</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Identifiers of virtual machines that can match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.
|
||
|
|
If None or empty, virtual machines with any identifier match the
|
||
|
|
filter.</li>
|
||
|
|
<li><strong>names</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Names that virtual machines must have to match the filter (see
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">VM.Info.name</span></tt>).
|
||
|
|
If None or empty, virtual machines with any name match the filter.</li>
|
||
|
|
<li><strong>folders</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Folders that must contain the virtual machine for the virtual
|
||
|
|
machine to match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the resource
|
||
|
|
type: <tt class="docutils literal"><span class="pre">Folder</span></tt>.
|
||
|
|
If None or empty, virtual machines in any folder match the filter.</li>
|
||
|
|
<li><strong>datacenters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Datacenters that must contain the virtual machine for the virtual
|
||
|
|
machine to match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">Datacenter</span></tt>. When methods return a value of this class as a
|
||
|
|
return value, the attribute will contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">Datacenter</span></tt>.
|
||
|
|
If None or empty, virtual machines in any datacenter match the
|
||
|
|
filter.</li>
|
||
|
|
<li><strong>hosts</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Hosts that must contain the virtual machine for the virtual machine
|
||
|
|
to match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">HostSystem</span></tt>.
|
||
|
|
If None or empty, virtual machines on any host match the filter.</li>
|
||
|
|
<li><strong>clusters</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Clusters that must contain the virtual machine for the virtual
|
||
|
|
machine to match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">ClusterComputeResource</span></tt>. When methods return a value of this
|
||
|
|
class as a return value, the attribute will contain identifiers for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">ClusterComputeResource</span></tt>.
|
||
|
|
If None or empty, virtual machines in any cluster match the filter.</li>
|
||
|
|
<li><strong>resource_pools</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</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>) – Resource pools that must contain the virtual machine for the
|
||
|
|
virtual machine to match the filter.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers 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 contain identifiers for the
|
||
|
|
resource type: <tt class="docutils literal"><span class="pre">ResourcePool</span></tt>.
|
||
|
|
If None or empty, virtual machines in any resource pool match the
|
||
|
|
filter.</li>
|
||
|
|
<li><strong>power_states</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> of <a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.Power.State" title="com.vmware.vcenter.vm_client.Power.State"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm_client.Power.State</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Power states that a virtual machine must be in to match the filter
|
||
|
|
(see <tt class="xref py py-attr docutils literal"><span class="pre">com.vmware.vcenter.vm_client.Power.Info.state</span></tt>.
|
||
|
|
If None or empty, virtual machines in any power state match the
|
||
|
|
filter.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.VM.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">VM.</tt><tt class="descname">Info</tt><big>(</big><em>guest_os=None</em>, <em>name=None</em>, <em>power_state=None</em>, <em>hardware=None</em>, <em>boot=None</em>, <em>boot_devices=None</em>, <em>cpu=None</em>, <em>memory=None</em>, <em>disks=None</em>, <em>nics=None</em>, <em>cdroms=None</em>, <em>floppies=None</em>, <em>parallel_ports=None</em>, <em>serial_ports=None</em>, <em>sata_adapters=None</em>, <em>scsi_adapters=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.VM.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>Document-based info.</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>guest_os</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.GuestOS" title="com.vmware.vcenter.vm_client.GuestOS"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm_client.GuestOS</span></tt></a>) – Guest OS.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine name.</li>
|
||
|
|
<li><strong>power_state</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.Power.State" title="com.vmware.vcenter.vm_client.Power.State"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm_client.Power.State</span></tt></a>) – Power state of the virtual machine.</li>
|
||
|
|
<li><strong>hardware</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.Hardware.Info" title="com.vmware.vcenter.vm_client.Hardware.Info"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm_client.Hardware.Info</span></tt></a>) – Virtual hardware version information.</li>
|
||
|
|
<li><strong>boot</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Boot.Info" title="com.vmware.vcenter.vm.hardware_client.Boot.Info"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Boot.Info</span></tt></a>) – Boot configuration.</li>
|
||
|
|
<li><strong>boot_devices</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#com.vmware.vcenter.vm.hardware.boot_client.Device.Entry" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Entry"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.boot_client.Device.Entry</span></tt></a>) – Boot device configuration. If the <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> has no entries, a
|
||
|
|
server-specific default boot sequence is used.</li>
|
||
|
|
<li><strong>cpu</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Cpu.Info" title="com.vmware.vcenter.vm.hardware_client.Cpu.Info"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Cpu.Info</span></tt></a>) – CPU configuration.</li>
|
||
|
|
<li><strong>memory</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Memory.Info" title="com.vmware.vcenter.vm.hardware_client.Memory.Info"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Memory.Info</span></tt></a>) – Memory configuration.</li>
|
||
|
|
<li><strong>disks</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.vm.html#com.vmware.vcenter.vm.hardware_client.Disk.Info" title="com.vmware.vcenter.vm.hardware_client.Disk.Info"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Disk.Info</span></tt></a>) – List of disks.
|
||
|
|
When clients pass a value of this class as a parameter, the key 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">com.vmware.vcenter.vm.hardware.Disk</span></tt>. When methods return
|
||
|
|
a value of this class as a return value, the key 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">com.vmware.vcenter.vm.hardware.Disk</span></tt>.</li>
|
||
|
|
<li><strong>nics</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.vm.html#com.vmware.vcenter.vm.hardware_client.Ethernet.Info" title="com.vmware.vcenter.vm.hardware_client.Ethernet.Info"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Ethernet.Info</span></tt></a>) – List of Ethernet adapters.
|
||
|
|
When clients pass a value of this class as a parameter, the key 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">com.vmware.vcenter.vm.hardware.Ethernet</span></tt>. When methods
|
||
|
|
return a value of this class as a return value, the key 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">com.vmware.vcenter.vm.hardware.Ethernet</span></tt>.</li>
|
||
|
|
<li><strong>cdroms</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.vm.html#com.vmware.vcenter.vm.hardware_client.Cdrom.Info" title="com.vmware.vcenter.vm.hardware_client.Cdrom.Info"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Cdrom.Info</span></tt></a>) – List of CD-ROMs.
|
||
|
|
When clients pass a value of this class as a parameter, the key 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">com.vmware.vcenter.vm.hardware.Cdrom</span></tt>. When methods return
|
||
|
|
a value of this class as a return value, the key 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">com.vmware.vcenter.vm.hardware.Cdrom</span></tt>.</li>
|
||
|
|
<li><strong>floppies</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.vm.html#com.vmware.vcenter.vm.hardware_client.Floppy.Info" title="com.vmware.vcenter.vm.hardware_client.Floppy.Info"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Floppy.Info</span></tt></a>) – List of floppy drives.
|
||
|
|
When clients pass a value of this class as a parameter, the key 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">com.vmware.vcenter.vm.hardware.Floppy</span></tt>. When methods
|
||
|
|
return a value of this class as a return value, the key 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">com.vmware.vcenter.vm.hardware.Floppy</span></tt>.</li>
|
||
|
|
<li><strong>parallel_ports</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.vm.html#com.vmware.vcenter.vm.hardware_client.Parallel.Info" title="com.vmware.vcenter.vm.hardware_client.Parallel.Info"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Parallel.Info</span></tt></a>) – List of parallel ports.
|
||
|
|
When clients pass a value of this class as a parameter, the key 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">com.vmware.vcenter.vm.hardware.ParallelPort</span></tt>. When methods
|
||
|
|
return a value of this class as a return value, the key 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">com.vmware.vcenter.vm.hardware.ParallelPort</span></tt>.</li>
|
||
|
|
<li><strong>serial_ports</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.vm.html#com.vmware.vcenter.vm.hardware_client.Serial.Info" title="com.vmware.vcenter.vm.hardware_client.Serial.Info"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client.Serial.Info</span></tt></a>) – List of serial ports.
|
||
|
|
When clients pass a value of this class as a parameter, the key 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">com.vmware.vcenter.vm.hardware.SerialPort</span></tt>. When methods
|
||
|
|
return a value of this class as a return value, the key 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">com.vmware.vcenter.vm.hardware.SerialPort</span></tt>.</li>
|
||
|
|
<li><strong>sata_adapters</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.vm.hardware.html#com.vmware.vcenter.vm.hardware.adapter_client.Sata.Info" title="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Info"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client.Sata.Info</span></tt></a>) – List of SATA adapters.
|
||
|
|
When clients pass a value of this class as a parameter, the key 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">com.vmware.vcenter.vm.hardware.SataAdapter</span></tt>. When methods
|
||
|
|
return a value of this class as a return value, the key 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">com.vmware.vcenter.vm.hardware.SataAdapter</span></tt>.</li>
|
||
|
|
<li><strong>scsi_adapters</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.vm.hardware.html#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Info" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Info"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Info</span></tt></a>) – List of SCSI adapters.
|
||
|
|
When clients pass a value of this class as a parameter, the key 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">com.vmware.vcenter.vm.hardware.ScsiAdapter</span></tt>. When methods
|
||
|
|
return a value of this class as a return value, the key 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">com.vmware.vcenter.vm.hardware.ScsiAdapter</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.VM.PlacementSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">VM.</tt><tt class="descname">PlacementSpec</tt><big>(</big><em>folder=None</em>, <em>resource_pool=None</em>, <em>host=None</em>, <em>cluster=None</em>, <em>datastore=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.VM.PlacementSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">VM.PlacementSpec</span></tt> class contains information used to place a virtual
|
||
|
|
machine onto resources within the vCenter inventory.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>folder</strong> (<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>) – Virtual machine folder into which the virtual machine should be
|
||
|
|
placed.
|
||
|
|
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>.
|
||
|
|
This attribute is currently required. In the future, if this
|
||
|
|
attribute is None, the system will attempt to choose a suitable
|
||
|
|
folder for the virtual machine; if a folder cannot be chosen, the
|
||
|
|
virtual machine creation operation will fail.</li>
|
||
|
|
<li><strong>resource_pool</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>) – Resource pool into which the virtual machine should be placed.
|
||
|
|
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>.
|
||
|
|
This attribute is currently required if both <tt class="docutils literal"><span class="pre">host</span></tt> and
|
||
|
|
<tt class="docutils literal"><span class="pre">cluster</span></tt> are None. In the future, if this attribute is None, the
|
||
|
|
system will attempt to choose a suitable resource pool for the
|
||
|
|
virtual machine; if a resource pool cannot be chosen, the virtual
|
||
|
|
machine creation operation will fail.</li>
|
||
|
|
<li><strong>host</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>) – <p>Host onto which the virtual machine should be placed.</p>
|
||
|
|
<p>If <tt class="docutils literal"><span class="pre">host</span></tt> and <tt class="docutils literal"><span class="pre">resourcePool</span></tt> are both specified,
|
||
|
|
<tt class="docutils literal"><span class="pre">resourcePool</span></tt> must belong to <tt class="docutils literal"><span class="pre">host</span></tt>.</p>
|
||
|
|
<p>If <tt class="docutils literal"><span class="pre">host</span></tt> and <tt class="docutils literal"><span class="pre">cluster</span></tt> are both specified, <tt class="docutils literal"><span class="pre">host</span></tt> must be a
|
||
|
|
member of <tt class="docutils literal"><span class="pre">cluster</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>.
|
||
|
|
This attribute may be None if <tt class="docutils literal"><span class="pre">resourcePool</span></tt> or <tt class="docutils literal"><span class="pre">cluster</span></tt> is
|
||
|
|
specified. If None, the system will attempt to choose a suitable
|
||
|
|
host for the virtual machine; if a host cannot be chosen, the
|
||
|
|
virtual machine creation operation will fail.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>cluster</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>) – <p>Cluster onto which the virtual machine should be placed.</p>
|
||
|
|
<p>If <tt class="docutils literal"><span class="pre">cluster</span></tt> and <tt class="docutils literal"><span class="pre">resourcePool</span></tt> are both specified,
|
||
|
|
<tt class="docutils literal"><span class="pre">resourcePool</span></tt> must belong to <tt class="docutils literal"><span class="pre">cluster</span></tt>.</p>
|
||
|
|
<p>If <tt class="docutils literal"><span class="pre">cluster</span></tt> and <tt class="docutils literal"><span class="pre">host</span></tt> are both specified, <tt class="docutils literal"><span class="pre">host</span></tt> must be a
|
||
|
|
member of <tt class="docutils literal"><span class="pre">cluster</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">ClusterComputeResource</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">ClusterComputeResource</span></tt>.
|
||
|
|
If <tt class="docutils literal"><span class="pre">resourcePool</span></tt> or <tt class="docutils literal"><span class="pre">host</span></tt> is specified, it is recommended
|
||
|
|
that this attribute be None.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>datastore</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>) – Datastore on which the virtual machine’s configuration state should
|
||
|
|
be stored. This datastore will also be used for any virtual disks
|
||
|
|
that are created as part of the virtual machine creation operation.
|
||
|
|
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 currently required. In the future, if this
|
||
|
|
attribute is None, the system will attempt to choose suitable
|
||
|
|
storage for the virtual machine; if storage cannot be chosen, the
|
||
|
|
virtual machine creation operation will fail.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter_client.VM.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">VM.</tt><tt class="descname">Summary</tt><big>(</big><em>vm=None</em>, <em>name=None</em>, <em>power_state=None</em>, <em>cpu_count=None</em>, <em>memory_size_mib=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.VM.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">VM.Summary</span></tt> class contains commonly used information about a virtual
|
||
|
|
machine.</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>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the virtual machine.
|
||
|
|
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">VirtualMachine</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">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the Virtual machine.</li>
|
||
|
|
<li><strong>power_state</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.Power.State" title="com.vmware.vcenter.vm_client.Power.State"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vcenter.vm_client.Power.State</span></tt></a>) – Power state of the virtual machine.</li>
|
||
|
|
<li><strong>cpu_count</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Number of CPU cores.
|
||
|
|
This attribute will be None if the virtual machine configuration is
|
||
|
|
not available. For example, the configuration information would be
|
||
|
|
unavailable if the server is unable to access the virtual machine
|
||
|
|
files on disk, and is often also unavailable during the intial
|
||
|
|
phases of virtual machine creation.</li>
|
||
|
|
<li><strong>memory_size_mib</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Memory size in mebibytes.
|
||
|
|
This attribute will be None if the virtual machine configuration is
|
||
|
|
not available. For example, the configuration information would be
|
||
|
|
unavailable if the server is unable to access the virtual machine
|
||
|
|
files on disk, and is often also unavailable during the intial
|
||
|
|
phases of virtual machine creation.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.VM.create">
|
||
|
|
<tt class="descclassname">VM.</tt><tt class="descname">create</tt><big>(</big><em>spec</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.VM.create" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Creates a virtual machine.</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>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.CreateSpec" title="com.vmware.vcenter_client.VM.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">VM.CreateSpec</span></tt></a>) – Virtual machine specification.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">ID of newly-created virtual machine.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></tt>
|
||
|
|
if a virtual machine with the specified name already exists.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if any of the specified parameters are invalid.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if any of the resources specified in spec could not be found</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if a specified resource (eg. host) is not accessible.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></tt>
|
||
|
|
if any of the specified storage addresses (eg. IDE, SATA, SCSI)
|
||
|
|
result in a storage address conflict.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if any of the resources needed to create the virtual machine could
|
||
|
|
not be allocated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></tt>
|
||
|
|
if <tt class="docutils literal"><span class="pre">guestOS</span></tt> is not supported for the requested virtual hardware
|
||
|
|
version and spec includes None attributes that default to
|
||
|
|
guest-specific values.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.VM.delete">
|
||
|
|
<tt class="descclassname">VM.</tt><tt class="descname">delete</tt><big>(</big><em>vm</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.VM.delete" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Deletes a virtual machine.</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>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.VM.get">
|
||
|
|
<tt class="descclassname">VM.</tt><tt class="descname">get</tt><big>(</big><em>vm</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.VM.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns information about a virtual machine.</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>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.VM.Info" title="com.vmware.vcenter_client.VM.Info"><tt class="xref py py-class docutils literal"><span class="pre">VM.Info</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Information about the specified virtual machine.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter_client.VM.list">
|
||
|
|
<tt class="descclassname">VM.</tt><tt class="descname">list</tt><big>(</big><em>filter=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter_client.VM.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
||
|
|
checks) virtual machines in vCenter matching the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.VM.FilterSpec" title="com.vmware.vcenter_client.VM.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">VM.FilterSpec</span></tt></a>.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.FilterSpec" title="com.vmware.vcenter_client.VM.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">VM.FilterSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Specification of matching virtual machines for which information
|
||
|
|
should be returned.
|
||
|
|
If None, the behavior is equivalent to a <a class="reference internal" href="#com.vmware.vcenter_client.VM.FilterSpec" title="com.vmware.vcenter_client.VM.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">VM.FilterSpec</span></tt></a>
|
||
|
|
with all attributes None which means all virtual machines match the
|
||
|
|
filter.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.VM.list" title="com.vmware.vcenter_client.VM.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_client.VM.Summary" title="com.vmware.vcenter_client.VM.Summary"><tt class="xref py py-class docutils literal"><span class="pre">VM.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the virtual machines matching the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.VM.FilterSpec" title="com.vmware.vcenter_client.VM.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">VM.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">VM.FilterSpec.power_states</span></tt> attribute contains a
|
||
|
|
value that is not supported by the server.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if more than 1000 virtual machines match the
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.VM.FilterSpec" title="com.vmware.vcenter_client.VM.FilterSpec"><tt class="xref py py-class docutils literal"><span class="pre">VM.FilterSpec</span></tt></a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware">
|
||
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-com.vmware" title="Permalink to this headline">¶</a></h2>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar">
|
||
|
|
<div class="sphinxsidebarwrapper">
|
||
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#">com.vmware package</a><ul>
|
||
|
|
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
||
|
|
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h4>Previous topic</h4>
|
||
|
|
<p class="topless"><a href="com.html"
|
||
|
|
title="previous chapter">com package</a></p>
|
||
|
|
<h4>Next topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.appliance.html"
|
||
|
|
title="next chapter">com.vmware.appliance package</a></p>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="_sources/com.vmware.txt"
|
||
|
|
rel="nofollow">Show Source</a></li>
|
||
|
|
</ul>
|
||
|
|
<div id="searchbox" style="display: none">
|
||
|
|
<h3>Quick search</h3>
|
||
|
|
<form class="search" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" />
|
||
|
|
<input type="submit" value="Go" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
<p class="searchtip" style="font-size: 90%">
|
||
|
|
Enter search terms or a module, class or function name.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
>index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.appliance.html" title="com.vmware.appliance package"
|
||
|
|
>next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.html" title="com package"
|
||
|
|
>previous</a> |</li>
|
||
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> »</li>
|
||
|
|
<li><a href="com.html" >com package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2014-2017, VMware, Inc. All rights reserved.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|