mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 17:39:59 -05:00
7737 lines
705 KiB
HTML
7737 lines
705 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|||
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
|
|||
|
|
<title>com.vmware package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|||
|
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="com.vmware.appliance package" href="com.vmware.appliance.html" />
|
|||
|
|
<link rel="prev" title="com package" href="com.html" />
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search" >
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
6.9.1
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
|||
|
|
<li class="toctree-l3 current"><a class="current reference internal" href="#">com.vmware package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">vSphere Automation SDK for Python.</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
|
|||
|
|
<div class="rst-content">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|||
|
|
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li><a href="index.html">Docs</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>com.vmware package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.rst.txt" rel="nofollow"> View page source</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<div class="section" id="module-com.vmware">
|
|||
|
|
<span id="com-vmware-package"></span><h1>com.vmware package<a class="headerlink" href="#module-com.vmware" 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.firewall_client">com.vmware.appliance.networking.firewall_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.interfaces_client">com.vmware.appliance.networking.interfaces_client module</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#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html">com.vmware.appliance.recovery.backup package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup.job_client">com.vmware.appliance.recovery.backup.job_client module</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup.system_name_client">com.vmware.appliance.recovery.backup.system_name_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<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.reconciliation_client">com.vmware.appliance.recovery.reconciliation_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>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.appliance.system.html">com.vmware.appliance.system package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.system.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.system.html#module-com.vmware.appliance.system.time_client">com.vmware.appliance.system.time_client module</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.local_accounts_client">com.vmware.appliance.local_accounts_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.localaccounts_client">com.vmware.appliance.localaccounts_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.logging_client">com.vmware.appliance.logging_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.monitoring_client">com.vmware.appliance.monitoring_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.ntp_client">com.vmware.appliance.ntp_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.shutdown_client">com.vmware.appliance.shutdown_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.tymesync_client">com.vmware.appliance.tymesync_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.update_client">com.vmware.appliance.update_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>
|
|||
|
|
</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.task_client">com.vmware.cis.task_client module</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>
|
|||
|
|
</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>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.content.type.html">com.vmware.content.type package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.type.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.content.type.ovf.html">com.vmware.content.type.ovf package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.type.ovf.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.type.ovf.html#module-com.vmware.content.type.ovf.policy_client">com.vmware.content.type.ovf.policy_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.type.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.type.html#module-com.vmware.content.type.ovf_client">com.vmware.content.type.ovf_client module</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>
|
|||
|
|
</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.metadata.html">com.vmware.vapi.metadata package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html">com.vmware.vapi.metadata.authentication package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#module-com.vmware.vapi.metadata.authentication.service_client">com.vmware.vapi.metadata.authentication.service_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html">com.vmware.vapi.metadata.metamodel package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.resource_client">com.vmware.vapi.metadata.metamodel.resource_client module</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.service_client">com.vmware.vapi.metadata.metamodel.service_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html">com.vmware.vapi.metadata.privilege package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#module-com.vmware.vapi.metadata.privilege.service_client">com.vmware.vapi.metadata.privilege.service_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.authentication_client">com.vmware.vapi.metadata.authentication_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.cli_client">com.vmware.vapi.metadata.cli_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.metamodel_client">com.vmware.vapi.metadata.metamodel_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.privilege_client">com.vmware.vapi.metadata.privilege_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<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#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.errors_client">com.vmware.vapi.std.errors_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.interposition_client">com.vmware.vapi.std.interposition_client module</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.metadata_client">com.vmware.vapi.metadata_client module</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>
|
|||
|
|
</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.certificate_management.html">com.vmware.vcenter.certificate_management package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#module-com.vmware.vcenter.certificate_management.vcenter_client">com.vmware.vcenter.certificate_management.vcenter_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.compute.html">com.vmware.vcenter.compute package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html">com.vmware.vcenter.compute.policies package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html">com.vmware.vcenter.compute.policies.capabilities package</a><ul>
|
|||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
|
|||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
|
|||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
|
|||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
|
|||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#module-com.vmware.vcenter.compute.policies.capabilities_client">com.vmware.vcenter.compute.policies.capabilities_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.html#module-com.vmware.vcenter.compute.policies_client">com.vmware.vcenter.compute.policies_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.deployment.html">com.vmware.vcenter.deployment package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html">com.vmware.vcenter.deployment.install package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html">com.vmware.vcenter.deployment.install.initial_config package</a><ul>
|
|||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#module-com.vmware.vcenter.deployment.install.initial_config.remote_psc_client">com.vmware.vcenter.deployment.install.initial_config.remote_psc_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#module-com.vmware.vcenter.deployment.install.psc_client">com.vmware.vcenter.deployment.install.psc_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.html#module-com.vmware.vcenter.deployment.install_client">com.vmware.vcenter.deployment.install_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<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#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html">com.vmware.vcenter.hvc.links package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#module-com.vmware.vcenter.hvc.links.sync_client">com.vmware.vcenter.hvc.links.sync_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<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.links_client">com.vmware.vcenter.hvc.links_client module</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>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.storage.html">com.vmware.vcenter.storage package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.storage.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html">com.vmware.vcenter.storage.policies package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html#module-com.vmware.vcenter.storage.policies.compliance_client">com.vmware.vcenter.storage.policies.compliance_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.storage.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.storage.html#module-com.vmware.vcenter.storage.policies_client">com.vmware.vcenter.storage.policies_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.system_config.html">com.vmware.vcenter.system_config package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.system_config.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html">com.vmware.vcenter.system_config.features package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#module-com.vmware.vcenter.system_config.features.tech_preview_client">com.vmware.vcenter.system_config.features.tech_preview_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.vcha.html">com.vmware.vcenter.vcha package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vcha.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vcha.html#module-com.vmware.vcenter.vcha.cluster_client">com.vmware.vcenter.vcha.cluster_client module</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>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html">com.vmware.vcenter.vm.storage package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#module-com.vmware.vcenter.vm.storage.policy_client">com.vmware.vcenter.vm.storage.policy_client module</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.compute_client">com.vmware.vcenter.vm.compute_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.guest_client">com.vmware.vcenter.vm.guest_client module</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.storage_client">com.vmware.vcenter.vm.storage_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.vm_template.html">com.vmware.vcenter.vm_template package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#module-com.vmware.vcenter.vm_template.library_items_client">com.vmware.vcenter.vm_template.library_items_client module</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.certificate_management_client">com.vmware.vcenter.certificate_management_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.compute_client">com.vmware.vcenter.compute_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.datastore_client">com.vmware.vcenter.datastore_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.deployment_client">com.vmware.vcenter.deployment_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.guest_client">com.vmware.vcenter.guest_client module</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.identity_client">com.vmware.vcenter.identity_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.services_client">com.vmware.vcenter.services_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.storage_client">com.vmware.vcenter.storage_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.system_config_client">com.vmware.vcenter.system_config_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.tokenservice_client">com.vmware.vcenter.tokenservice_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.topology_client">com.vmware.vcenter.topology_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.vcha_client">com.vmware.vcenter.vcha_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.vm_template_client">com.vmware.vcenter.vm_template_client module</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>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance_client</span></code> module provides classes for managing
|
|||
|
|
vCenter Appliance configuration. The module is available starting in vSphere
|
|||
|
|
6.7.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Health">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">Health</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Health" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Health</span></code> class provides methods to retrieve the appliance health
|
|||
|
|
information. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Health.messages">
|
|||
|
|
<code class="sig-name descname">messages</code><span class="sig-paren">(</span><em class="sig-param">item</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Health.messages" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get health messages. This method was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of the data item
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.health</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance_client.Notification" title="com.vmware.appliance_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of the health messages</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
Unknown health item</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">LocalAccounts</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalAccounts</span></code> class provides methods to manage local user account.
|
|||
|
|
This class was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.Config">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param">password=None</em>, <em class="sig-param">old_password=None</em>, <em class="sig-param">full_name=None</em>, <em class="sig-param">email=None</em>, <em class="sig-param">roles=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">password_expires=None</em>, <em class="sig-param">password_expires_at=None</em>, <em class="sig-param">inactive_after_password_expiration=None</em>, <em class="sig-param">days_after_password_expiration=None</em>, <em class="sig-param">min_days_between_password_change=None</em>, <em class="sig-param">max_days_between_password_change=None</em>, <em class="sig-param">warn_days_before_password_expiration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.Config" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalAccounts.Config</span></code> class defines the information required for the
|
|||
|
|
account. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Password. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>old_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Old password of the user (required in case of the password change,
|
|||
|
|
not required if superAdmin user changes the password of the other
|
|||
|
|
user). This attribute was added in vSphere API 6.7.
|
|||
|
|
If None, user may not have password set.</p></li>
|
|||
|
|
<li><p><strong>full_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Full name of the user. This attribute was added in vSphere API 6.7.
|
|||
|
|
If None, user will have no fullname.</p></li>
|
|||
|
|
<li><p><strong>email</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Email address of the local account. This attribute was added in
|
|||
|
|
vSphere API 6.7.
|
|||
|
|
If None, user will have no email.</p></li>
|
|||
|
|
<li><p><strong>roles</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User roles. This attribute was added in vSphere API 6.7.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.roles</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will contain identifiers for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.roles</span></code>.</p></li>
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating if the account is enabled. This attribute was added
|
|||
|
|
in vSphere API 6.7.
|
|||
|
|
If None, defaults to True</p></li>
|
|||
|
|
<li><p><strong>password_expires</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating if the account password expires. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
If None, defaults to True.</p></li>
|
|||
|
|
<li><p><strong>password_expires_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Date when the account’s password will expire. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
If None, will be taken from system defaults (see
|
|||
|
|
local-accounts/policy).</p></li>
|
|||
|
|
<li><p><strong>inactive_after_password_expiration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating if the account will be locked after password
|
|||
|
|
expiration. This attribute was added in vSphere API 6.7.
|
|||
|
|
If None, defaults to True.</p></li>
|
|||
|
|
<li><p><strong>days_after_password_expiration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of days after password expiration before the account will be
|
|||
|
|
locked. This attribute was added in vSphere API 6.7.
|
|||
|
|
If None, will be taken from system defaults (see
|
|||
|
|
local-accounts/policy).</p></li>
|
|||
|
|
<li><p><strong>min_days_between_password_change</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Minimum number of days between password change. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
If None, will be taken from system defaults (see
|
|||
|
|
local-accounts/policy).</p></li>
|
|||
|
|
<li><p><strong>max_days_between_password_change</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of days between password change. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
If None, will be taken from system defaults (see
|
|||
|
|
local-accounts/policy).</p></li>
|
|||
|
|
<li><p><strong>warn_days_before_password_expiration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of days of warning before password expires. This attribute
|
|||
|
|
was added in vSphere API 6.7.
|
|||
|
|
If None, will be taken from system defaults (see
|
|||
|
|
local-accounts/policy).</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">fullname=None</em>, <em class="sig-param">email=None</em>, <em class="sig-param">roles=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">has_password=None</em>, <em class="sig-param">last_password_change=None</em>, <em class="sig-param">password_expires_at=None</em>, <em class="sig-param">inactive_at=None</em>, <em class="sig-param">min_days_between_password_change=None</em>, <em class="sig-param">max_days_between_password_change=None</em>, <em class="sig-param">warn_days_before_password_expiration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalAccounts.Info</span></code> class defines the local account properties. This
|
|||
|
|
class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>fullname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Full name of the user. This attribute was added in vSphere API 6.7.
|
|||
|
|
If None, the value was never set.</p></li>
|
|||
|
|
<li><p><strong>email</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Email address of the local account. This attribute was added in
|
|||
|
|
vSphere API 6.7.
|
|||
|
|
If None, the value was never set.</p></li>
|
|||
|
|
<li><p><strong>roles</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User roles. This attribute was added in vSphere API 6.7.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.roles</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will contain identifiers for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.roles</span></code>.</p></li>
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating if the account is enabled. This attribute was added
|
|||
|
|
in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>has_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Is the user password set. This attribute was added in vSphere API
|
|||
|
|
6.7.</p></li>
|
|||
|
|
<li><p><strong>last_password_change</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Date and time password was changed. This attribute was added in
|
|||
|
|
vSphere API 6.7.
|
|||
|
|
If None, the password was never set.</p></li>
|
|||
|
|
<li><p><strong>password_expires_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Date when the account’s password will expire. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
If None, the password never expires.</p></li>
|
|||
|
|
<li><p><strong>inactive_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Date and time account will be locked after password expiration.
|
|||
|
|
This attribute was added in vSphere API 6.7.
|
|||
|
|
If None, account will not be locked.</p></li>
|
|||
|
|
<li><p><strong>min_days_between_password_change</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Minimum number of days between password change. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
If None, pasword can be changed any time.</p></li>
|
|||
|
|
<li><p><strong>max_days_between_password_change</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of days between password change. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
If None, password never expires.</p></li>
|
|||
|
|
<li><p><strong>warn_days_before_password_expiration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of days of warning before password expires. This attribute
|
|||
|
|
was added in vSphere API 6.7.
|
|||
|
|
If None, a user is never warned.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.UpdateConfig">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateConfig</code><span class="sig-paren">(</span><em class="sig-param">password=None</em>, <em class="sig-param">old_password=None</em>, <em class="sig-param">full_name=None</em>, <em class="sig-param">email=None</em>, <em class="sig-param">roles=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">password_expires=None</em>, <em class="sig-param">password_expires_at=None</em>, <em class="sig-param">inactive_after_password_expiration=None</em>, <em class="sig-param">days_after_password_expiration=None</em>, <em class="sig-param">min_days_between_password_change=None</em>, <em class="sig-param">max_days_between_password_change=None</em>, <em class="sig-param">warn_days_before_password_expiration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.UpdateConfig" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalAccounts.UpdateConfig</span></code> class defines the fields that might be
|
|||
|
|
updated. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Password. This attribute was added in vSphere API 6.7.
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
<li><p><strong>old_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Old password of the user (required in case of the password change,
|
|||
|
|
not required if superAdmin user changes the password of the other
|
|||
|
|
user). This attribute was added in vSphere API 6.7.
|
|||
|
|
If None, user may not have password set.</p></li>
|
|||
|
|
<li><p><strong>full_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Full name of the user. This attribute was added in vSphere API 6.7.
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
<li><p><strong>email</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Email address of the local account. This attribute was added in
|
|||
|
|
vSphere API 6.7.
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
<li><p><strong>roles</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – User roles. This attribute was added in vSphere API 6.7.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.roles</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will contain identifiers for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.roles</span></code>.
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating if the account is enabled. This attribute was added
|
|||
|
|
in vSphere API 6.7.
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
<li><p><strong>password_expires</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating if the account password expires. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
<li><p><strong>password_expires_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Date when the account’s password will expire. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
<li><p><strong>inactive_after_password_expiration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating if the account will be locked after password
|
|||
|
|
expiration. This attribute was added in vSphere API 6.7.
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
<li><p><strong>days_after_password_expiration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of days after password expiration before the account will be
|
|||
|
|
locked. This attribute was added in vSphere API 6.7.
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
<li><p><strong>min_days_between_password_change</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Minimum number of days between password change. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
<li><p><strong>max_days_between_password_change</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of days between password change. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
<li><p><strong>warn_days_before_password_expiration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of days of warning before password expires. This attribute
|
|||
|
|
was added in vSphere API 6.7.
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">username</em>, <em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Create a new local user account. This method was added in vSphere API
|
|||
|
|
6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User login name
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.local_accounts</span></code>.</p></li>
|
|||
|
|
<li><p><strong>config</strong> (<a class="reference internal" href="#com.vmware.appliance_client.LocalAccounts.Config" title="com.vmware.appliance_client.LocalAccounts.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalAccounts.Config</span></code></a>) – User configuration</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
If an account already exists</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If a username is invalid (username is validated against
|
|||
|
|
[a-zA-Z0-9][a-zA-Z0-9-.\@]*[a-zA-Z0-9] pattern)</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">username</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Delete a local user account. This method was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User login name
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.local_accounts</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If the account is not found</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">username</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get the local user account information. This method was added in
|
|||
|
|
vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User login name</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance_client.LocalAccounts.Info" title="com.vmware.appliance_client.LocalAccounts.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalAccounts.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Local user account information</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If the account is not found</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get a list of the local user accounts. This method was added in vSphere
|
|||
|
|
API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance_client.LocalAccounts.list" title="com.vmware.appliance_client.LocalAccounts.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>List of identifiers
|
|||
|
|
The return value will contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.local_accounts</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.set">
|
|||
|
|
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">username</em>, <em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.set" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set local user account properties. This method was added in vSphere API
|
|||
|
|
6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User login name
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.local_accounts</span></code>.</p></li>
|
|||
|
|
<li><p><strong>config</strong> (<a class="reference internal" href="#com.vmware.appliance_client.LocalAccounts.Config" title="com.vmware.appliance_client.LocalAccounts.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalAccounts.Config</span></code></a>) – User configuration</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If the account is not found</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">username</em>, <em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Update selected fields in local user account properties. This method
|
|||
|
|
was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User login name
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.local_accounts</span></code>.</p></li>
|
|||
|
|
<li><p><strong>config</strong> (<a class="reference internal" href="#com.vmware.appliance_client.LocalAccounts.UpdateConfig" title="com.vmware.appliance_client.LocalAccounts.UpdateConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalAccounts.UpdateConfig</span></code></a>) – User configuration</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If the account is not found</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">Monitoring</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Monitoring</span></code> class provides methods Get and list monitoring data for
|
|||
|
|
requested item.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.FunctionType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FunctionType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.FunctionType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Monitoring.FunctionType</span></code> class Defines aggregation function</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">FunctionType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.FunctionType.AVG">
|
|||
|
|
<code class="sig-name descname">AVG</code><em class="property"> = FunctionType(string='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">
|
|||
|
|
<code class="sig-name descname">COUNT</code><em class="property"> = FunctionType(string='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">
|
|||
|
|
<code class="sig-name descname">MAX</code><em class="property"> = FunctionType(string='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">
|
|||
|
|
<code class="sig-name descname">MIN</code><em class="property"> = FunctionType(string='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><code class="sig-name descname">IntervalType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Monitoring.IntervalType</span></code> class Defines interval between the values in
|
|||
|
|
hours and mins, for which aggregation will apply</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">IntervalType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType.DAY1">
|
|||
|
|
<code class="sig-name descname">DAY1</code><em class="property"> = IntervalType(string='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">
|
|||
|
|
<code class="sig-name descname">HOURS2</code><em class="property"> = IntervalType(string='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">
|
|||
|
|
<code class="sig-name descname">HOURS6</code><em class="property"> = IntervalType(string='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">
|
|||
|
|
<code class="sig-name descname">MINUTES30</code><em class="property"> = IntervalType(string='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">
|
|||
|
|
<code class="sig-name descname">MINUTES5</code><em class="property"> = IntervalType(string='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><code class="sig-name descname">MonitoredItem</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">units=None</em>, <em class="sig-param">category=None</em>, <em class="sig-param">instance=None</em>, <em class="sig-param">description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.MonitoredItem" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Monitoring.MonitoredItem</span></code> class Structure representing requested
|
|||
|
|
monitored item data.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.monitoring</span></code>. When methods return a value of
|
|||
|
|
this class as a return value, the attribute will be an identifier
|
|||
|
|
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.monitoring</span></code>.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – monitored item name Ex: “Network write speed”</p></li>
|
|||
|
|
<li><p><strong>units</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Y-axis label EX: “Mbps”, “%”</p></li>
|
|||
|
|
<li><p><strong>category</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – category Ex: network, storage etc</p></li>
|
|||
|
|
<li><p><strong>instance</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – instance name Ex: eth0</p></li>
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – monitored item description Ex:
|
|||
|
|
com.vmware.applmgmt.mon.descr.net.rx.packetRate.eth0</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.MonitoredItemData">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">MonitoredItemData</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">interval=None</em>, <em class="sig-param">function=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.MonitoredItemData" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Monitoring.MonitoredItemData</span></code> class Structure representing monitored
|
|||
|
|
item data.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.monitoring</span></code>. When methods return a value of
|
|||
|
|
this class as a return value, the attribute will be an identifier
|
|||
|
|
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.monitoring</span></code>.</p></li>
|
|||
|
|
<li><p><strong>interval</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Monitoring.IntervalType" title="com.vmware.appliance_client.Monitoring.IntervalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Monitoring.IntervalType</span></code></a>) – interval between values in hours, minutes</p></li>
|
|||
|
|
<li><p><strong>function</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Monitoring.FunctionType" title="com.vmware.appliance_client.Monitoring.FunctionType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Monitoring.FunctionType</span></code></a>) – aggregation function</p></li>
|
|||
|
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Start time in UTC</p></li>
|
|||
|
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – End time in UTC</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – list of values</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">MonitoredItemDataRequest</code><span class="sig-paren">(</span><em class="sig-param">names=None</em>, <em class="sig-param">interval=None</em>, <em class="sig-param">function=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Monitoring.MonitoredItemDataRequest</span></code> class Structure representing
|
|||
|
|
requested monitored item data.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.monitoring</span></code>. When methods return a value of
|
|||
|
|
this class as a return value, the attribute will contain
|
|||
|
|
identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.monitoring</span></code>.</p></li>
|
|||
|
|
<li><p><strong>interval</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Monitoring.IntervalType" title="com.vmware.appliance_client.Monitoring.IntervalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Monitoring.IntervalType</span></code></a>) – interval between values in hours, minutes</p></li>
|
|||
|
|
<li><p><strong>function</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Monitoring.FunctionType" title="com.vmware.appliance_client.Monitoring.FunctionType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Monitoring.FunctionType</span></code></a>) – aggregation function</p></li>
|
|||
|
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Start time in UTC</p></li>
|
|||
|
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – End time in UTC</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">stat_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get monitored item info</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stat_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – statistic item id
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.monitoring</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance_client.Monitoring.MonitoredItem" title="com.vmware.appliance_client.Monitoring.MonitoredItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">Monitoring.MonitoredItem</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>MonitoredItem structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get monitored items list</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance_client.Monitoring.list" title="com.vmware.appliance_client.Monitoring.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.appliance_client.Monitoring.MonitoredItem" title="com.vmware.appliance_client.Monitoring.MonitoredItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">Monitoring.MonitoredItem</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>list of names</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.query">
|
|||
|
|
<code class="sig-name descname">query</code><span class="sig-paren">(</span><em class="sig-param">item</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.query" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get monitoring data.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>item</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest" title="com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">Monitoring.MonitoredItemDataRequest</span></code></a>) – MonitoredItemDataRequest Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance_client.Monitoring.list" title="com.vmware.appliance_client.Monitoring.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.appliance_client.Monitoring.MonitoredItemData" title="com.vmware.appliance_client.Monitoring.MonitoredItemData"><code class="xref py py-class docutils literal notranslate"><span class="pre">Monitoring.MonitoredItemData</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>list of MonitoredItemData structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">Networking</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Networking</span></code> class provides methods Get Network configurations. This
|
|||
|
|
class was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.ChangeSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ChangeSpec</code><span class="sig-paren">(</span><em class="sig-param">hostname=None</em>, <em class="sig-param">sso_user=None</em>, <em class="sig-param">sso_password=None</em>, <em class="sig-param">dns=None</em>, <em class="sig-param">ipv4=None</em>, <em class="sig-param">ipv6=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.ChangeSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – New hostname to assign to the management network of vCenter
|
|||
|
|
appliance. This attribute was added in vSphere API 6.7.3.</p></li>
|
|||
|
|
<li><p><strong>sso_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – vCenter Server SSO administrator username. This attribute was added
|
|||
|
|
in vSphere API 6.7.3.</p></li>
|
|||
|
|
<li><p><strong>sso_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – vCenter Server SSO administrator Password. This attribute was added
|
|||
|
|
in vSphere API 6.7.3.</p></li>
|
|||
|
|
<li><p><strong>dns</strong> (<a class="reference internal" href="com.vmware.appliance.networking.html#com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig" title="com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – DNS Configuration to set for the machine. This attribute was added
|
|||
|
|
in vSphere API 6.7.3.
|
|||
|
|
If None DNS settings will not be changed</p></li>
|
|||
|
|
<li><p><strong>ipv4</strong> (<a class="reference internal" href="com.vmware.appliance.networking.html#com.vmware.appliance.networking.interfaces_client.Ipv4.Config" title="com.vmware.appliance.networking.interfaces_client.Ipv4.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.networking.interfaces_client.Ipv4.Config</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IPv4 Configuration to set for the machine. This attribute was added
|
|||
|
|
in vSphere API 6.7.3.
|
|||
|
|
If None IPv4 settings will not be changed</p></li>
|
|||
|
|
<li><p><strong>ipv6</strong> (<a class="reference internal" href="com.vmware.appliance.networking.html#com.vmware.appliance.networking.interfaces_client.Ipv6.Config" title="com.vmware.appliance.networking.interfaces_client.Ipv6.Config"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.networking.interfaces_client.Ipv6.Config</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IPv6 Configuration to set for the machine. This attribute was added
|
|||
|
|
in vSphere API 6.7.3.
|
|||
|
|
If None IPv6 settings will not be changed</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.DNSInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">DNSInfo</code><span class="sig-paren">(</span><em class="sig-param">mode=None</em>, <em class="sig-param">hostname=None</em>, <em class="sig-param">servers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.DNSInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Networking.DNSInfo</span></code> class contains information about the DNS
|
|||
|
|
configuration of a virtual appliance. This class was added in vSphere API
|
|||
|
|
6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>mode</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Networking.DNSInfo.DNSMode" title="com.vmware.appliance_client.Networking.DNSInfo.DNSMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networking.DNSInfo.DNSMode</span></code></a>) – DNS mode. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Hostname. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Servers. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.DNSInfo.DNSMode">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">DNSMode</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.DNSInfo.DNSMode" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Networking.DNSInfo.DNSMode</span></code> class describes the source of DNS
|
|||
|
|
servers. This enumeration was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">DNSMode</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.DNSInfo.DNSMode.DHCP">
|
|||
|
|
<code class="sig-name descname">DHCP</code><em class="property"> = DNSMode(string='DHCP')</em><a class="headerlink" href="#com.vmware.appliance_client.Networking.DNSInfo.DNSMode.DHCP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The DNS servers addresses are obtained from a DHCP server. This class
|
|||
|
|
attribute was added in vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.DNSInfo.DNSMode.STATIC">
|
|||
|
|
<code class="sig-name descname">STATIC</code><em class="property"> = DNSMode(string='STATIC')</em><a class="headerlink" href="#com.vmware.appliance_client.Networking.DNSInfo.DNSMode.STATIC" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The DNS servers addresses are specified explicitly. This class attribute
|
|||
|
|
was added in vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">dns=None</em>, <em class="sig-param">interfaces=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Networking.Info</span></code> class contains information about the network
|
|||
|
|
configuration of a virtual appliance. This class was added in vSphere API
|
|||
|
|
6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>dns</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Networking.DNSInfo" title="com.vmware.appliance_client.Networking.DNSInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networking.DNSInfo</span></code></a>) – DNS configuration. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>interfaces</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.appliance.html#com.vmware.appliance.networking_client.Interfaces.InterfaceInfo" title="com.vmware.appliance.networking_client.Interfaces.InterfaceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.networking_client.Interfaces.InterfaceInfo</span></code></a>) – Interface configuration as a key-value map where key is a network
|
|||
|
|
interface name, for example, “nic0”. This attribute was added in
|
|||
|
|
vSphere API 6.7.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.networking.interfaces</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the key in the
|
|||
|
|
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.networking.interfaces</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">ipv6_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Networking.UpdateSpec</span></code> class describes whether to enable or disable
|
|||
|
|
ipv6 on interfaces. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>ipv6_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IPv6 Enabled or not. This attribute was added in vSphere API 6.7.
|
|||
|
|
If unspecified, leaves the current state of Ipv6.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.change_task">
|
|||
|
|
<code class="sig-name descname">change_task</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.change_task" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Changes the Hostname/IP of the management network of vCenter appliance.
|
|||
|
|
The Hostname/IP change invokes the PNID change process which involves
|
|||
|
|
LDAP entry modification, updating registry entries, configuration files
|
|||
|
|
modification and network configuration changes. vCenter server is
|
|||
|
|
expected to be down for few minutes during these changes. This method
|
|||
|
|
was added in vSphere API 6.7.3.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Networking.ChangeSpec" title="com.vmware.appliance_client.Networking.ChangeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networking.ChangeSpec</span></code></a>) – Information required to change the hostname.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if it’s not embedded node</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if passed arguments are invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if another change task is in progress</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get Networking information for all configured interfaces. This method
|
|||
|
|
was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance_client.Networking.Info" title="com.vmware.appliance_client.Networking.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networking.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>The Map of network configuration info for all interfaces.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.reset">
|
|||
|
|
<code class="sig-name descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.reset" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Reset and restarts network configuration on all interfaces, also this
|
|||
|
|
will renew the DHCP lease for DHCP IP address. This method was added in
|
|||
|
|
vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Enable or Disable ipv6 on all interfaces. This method was added in
|
|||
|
|
vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Networking.UpdateSpec" title="com.vmware.appliance_client.Networking.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networking.UpdateSpec</span></code></a>) – update spec with optional boolean value</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Notification">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">Notification</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">time=None</em>, <em class="sig-param">message=None</em>, <em class="sig-param">resolution=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Notification" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Notification</span></code> class describes a notification that can be reported by
|
|||
|
|
the appliance task. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The notification id. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The time the notification was raised/found. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
Only if the time information is available.</p></li>
|
|||
|
|
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The notification message. This attribute was added in vSphere API
|
|||
|
|
6.7.</p></li>
|
|||
|
|
<li><p><strong>resolution</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The resolution message, if any. This attribute was added in vSphere
|
|||
|
|
API 6.7.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> for warnings and errors.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Notifications">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">Notifications</code><span class="sig-paren">(</span><em class="sig-param">info=None</em>, <em class="sig-param">warnings=None</em>, <em class="sig-param">errors=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Notifications" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Notifications</span></code> class contains info/warning/error messages that can
|
|||
|
|
be reported be the appliance task. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance_client.Notification" title="com.vmware.appliance_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Info notification messages reported. This attribute was added in
|
|||
|
|
vSphere API 6.7.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an info was reported by the appliance task.</p></li>
|
|||
|
|
<li><p><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance_client.Notification" title="com.vmware.appliance_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Warning notification messages reported. This attribute was added in
|
|||
|
|
vSphere API 6.7.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an warning was reported by the appliance task.</p></li>
|
|||
|
|
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance_client.Notification" title="com.vmware.appliance_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Error notification messages reported. This attribute was added in
|
|||
|
|
vSphere API 6.7.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an error was reported by the appliance task.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">Ntp</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Ntp</span></code> class provides methods Gets NTP configuration status and tests
|
|||
|
|
connection to ntp servers. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.LocalizableMessage">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">LocalizableMessage</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">default_message=None</em>, <em class="sig-param">args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp.LocalizableMessage" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Ntp.LocalizableMessage</span></code> class Structure representing message. This class
|
|||
|
|
was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – id in message bundle. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>default_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – text in english. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – nested data. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.ServerStatus">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ServerStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp.ServerStatus" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Ntp.ServerStatus</span></code> class Status of server during test. This enumeration
|
|||
|
|
was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ServerStatus</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.ServerStatus.SERVER_REACHABLE">
|
|||
|
|
<code class="sig-name descname">SERVER_REACHABLE</code><em class="property"> = ServerStatus(string='SERVER_REACHABLE')</em><a class="headerlink" href="#com.vmware.appliance_client.Ntp.ServerStatus.SERVER_REACHABLE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Server is reachable. This class attribute was added in vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.ServerStatus.SERVER_UNREACHABLE">
|
|||
|
|
<code class="sig-name descname">SERVER_UNREACHABLE</code><em class="property"> = ServerStatus(string='SERVER_UNREACHABLE')</em><a class="headerlink" href="#com.vmware.appliance_client.Ntp.ServerStatus.SERVER_UNREACHABLE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Server is unreachable. This class attribute was added in vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.TestRunStatus">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">TestRunStatus</code><span class="sig-paren">(</span><em class="sig-param">server=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp.TestRunStatus" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Ntp.TestRunStatus</span></code> class Status of the test. This class was added in
|
|||
|
|
vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>server</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Server name associated with the test run. This attribute was added
|
|||
|
|
in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Ntp.ServerStatus" title="com.vmware.appliance_client.Ntp.ServerStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ntp.ServerStatus</span></code></a>) – Server status. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>message</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Ntp.LocalizableMessage" title="com.vmware.appliance_client.Ntp.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ntp.LocalizableMessage</span></code></a>) – Message associated with status. This attribute was added in vSphere
|
|||
|
|
API 6.7.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get the NTP configuration status. If you run the ‘timesync.get’
|
|||
|
|
command, you can retrieve the current time synchronization method (NTP-
|
|||
|
|
or VMware Tools-based). The ‘ntp’ command always returns the NTP server
|
|||
|
|
information, even when the time synchronization mode is not set to NTP.
|
|||
|
|
If the time synchronization mode is not NTP-based, the NTP server
|
|||
|
|
status is displayed as down. This method was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>List of NTP servers.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.set">
|
|||
|
|
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">servers</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp.set" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set NTP servers. This method updates old NTP servers from configuration
|
|||
|
|
and sets the input NTP servers in the configuration. If NTP based time
|
|||
|
|
synchronization is used internally, the NTP daemon will be restarted to
|
|||
|
|
reload given NTP configuration. In case NTP based time synchronization
|
|||
|
|
is not used, this method only replaces servers in the NTP
|
|||
|
|
configuration. This method was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of host names or ip addresses of ntp servers.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.test">
|
|||
|
|
<code class="sig-name descname">test</code><span class="sig-paren">(</span><em class="sig-param">servers</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp.test" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Test the connection to a list of ntp servers. This method was added in
|
|||
|
|
vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of host names or IP addresses of NTP servers.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance_client.Ntp.TestRunStatus" title="com.vmware.appliance_client.Ntp.TestRunStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ntp.TestRunStatus</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of test run statuses.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Recovery">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">Recovery</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Recovery" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Recovery</span></code> class provides methods to invoke an appliance recovery
|
|||
|
|
(backup and restore). This class was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Recovery.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">supported=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Recovery.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Recovery.Info</span></code> class contains the information about the appliance
|
|||
|
|
recovery environment. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>supported</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Is recovery supported in this appliance. This attribute was added
|
|||
|
|
in vSphere API 6.7.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Recovery.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Recovery.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Gets the properties of the appliance Recovery subsystem. This method
|
|||
|
|
was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance_client.Recovery.Info" title="com.vmware.appliance_client.Recovery.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Recovery.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Structure containing the properties of the Recovery subsystem.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">Services</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Service</span></code> class provides methods to manage a single/set of appliance
|
|||
|
|
services. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">description=None</em>, <em class="sig-param">state=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Services.Info</span></code> class contains information about a service. This
|
|||
|
|
class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Service description. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Services.State" title="com.vmware.appliance_client.Services.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.State</span></code></a>) – Running State. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.State">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.State" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Services.State</span></code> class defines valid Run State for services. This
|
|||
|
|
enumeration was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.State.STARTED">
|
|||
|
|
<code class="sig-name descname">STARTED</code><em class="property"> = State(string='STARTED')</em><a class="headerlink" href="#com.vmware.appliance_client.Services.State.STARTED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Service Run State is Started, it is fully functional. This class attribute
|
|||
|
|
was added in vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.State.STARTING">
|
|||
|
|
<code class="sig-name descname">STARTING</code><em class="property"> = State(string='STARTING')</em><a class="headerlink" href="#com.vmware.appliance_client.Services.State.STARTING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Service Run State is Starting, it is still not functional. This class
|
|||
|
|
attribute was added in vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.State.STOPPED">
|
|||
|
|
<code class="sig-name descname">STOPPED</code><em class="property"> = State(string='STOPPED')</em><a class="headerlink" href="#com.vmware.appliance_client.Services.State.STOPPED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Service Run State is Stopped. This class attribute was added in vSphere API
|
|||
|
|
6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.State.STOPPING">
|
|||
|
|
<code class="sig-name descname">STOPPING</code><em class="property"> = State(string='STOPPING')</em><a class="headerlink" href="#com.vmware.appliance_client.Services.State.STOPPING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Service Run State is Stopping, it is not functional. This class attribute
|
|||
|
|
was added in vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns the state of a service. This method was added in vSphere API
|
|||
|
|
6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service whose state is being queried.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.services</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance_client.Services.Info" title="com.vmware.appliance_client.Services.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Service Info structure.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any other error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Lists details of vCenter services. This method was added in vSphere API
|
|||
|
|
6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.appliance_client.Services.Info" title="com.vmware.appliance_client.Services.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Map of service identifiers to service Info structures.
|
|||
|
|
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.services</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.restart">
|
|||
|
|
<code class="sig-name descname">restart</code><span class="sig-paren">(</span><em class="sig-param">service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.restart" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Restarts a service. This method was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service to restart
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.services</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code></a>
|
|||
|
|
if any timeout occurs during the execution of the restart
|
|||
|
|
operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the operation is denied in the current state of the service. If
|
|||
|
|
a stop or start operation is in progress, issuing a restart
|
|||
|
|
operation will lead to this error.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if a restart operation is issued on a service which has startup
|
|||
|
|
type null</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any other error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.start">
|
|||
|
|
<code class="sig-name descname">start</code><span class="sig-paren">(</span><em class="sig-param">service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.start" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Starts a service. This method was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service to start
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.services</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the operation is denied in the current state of the service. If
|
|||
|
|
a stop or restart operation is in progress, the start operation
|
|||
|
|
will not be allowed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if start operation is issued on a service which has startup type
|
|||
|
|
null.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code></a>
|
|||
|
|
if any timeout occurs during the execution of the start operation.
|
|||
|
|
Timeout occurs when the service takes longer than StartTimeout to
|
|||
|
|
start.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any other error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.stop">
|
|||
|
|
<code class="sig-name descname">stop</code><span class="sig-paren">(</span><em class="sig-param">service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.stop" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Stops a service. This method was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the service to stop
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.services</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any other error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the operation is denied in the current state of the service. If
|
|||
|
|
a stop operation is in progress, issuing another stop operation
|
|||
|
|
will lead to this error.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Shutdown">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">Shutdown</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Shutdown" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Shutdown</span></code> class provides methods Performs reboot/shutdown operations on
|
|||
|
|
appliance. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Shutdown.ShutdownConfig">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ShutdownConfig</code><span class="sig-paren">(</span><em class="sig-param">shutdown_time=None</em>, <em class="sig-param">action=None</em>, <em class="sig-param">reason=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Shutdown.ShutdownConfig" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Shutdown.ShutdownConfig</span></code> class Structure that defines shutdown
|
|||
|
|
configuration returned by the Shutdown.get operation. This class was added
|
|||
|
|
in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>shutdown_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Shutdown time. This attribute was added in vSphere API 6.7.
|
|||
|
|
shutdownTime Optional value of pending shutdown time</p></li>
|
|||
|
|
<li><p><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The pending shutdown operation. The string values for pending
|
|||
|
|
operations can be ‘poweroff’, ‘reboot’ or ‘’. This attribute was
|
|||
|
|
added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>reason</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The reason behind the shutdown action. This attribute was added in
|
|||
|
|
vSphere API 6.7.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Shutdown.cancel">
|
|||
|
|
<code class="sig-name descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Shutdown.cancel" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Cancel pending shutdown action. This method was added in vSphere API
|
|||
|
|
6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Shutdown.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Shutdown.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get details about the pending shutdown action. This method was added in
|
|||
|
|
vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance_client.Shutdown.ShutdownConfig" title="com.vmware.appliance_client.Shutdown.ShutdownConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shutdown.ShutdownConfig</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Configuration of pending shutdown action.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Shutdown.poweroff">
|
|||
|
|
<code class="sig-name descname">poweroff</code><span class="sig-paren">(</span><em class="sig-param">delay</em>, <em class="sig-param">reason</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Shutdown.poweroff" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Power off the appliance. This method was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minutes after which poweroff should start. If 0 is specified,
|
|||
|
|
poweroff will start immediately.</p></li>
|
|||
|
|
<li><p><strong>reason</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Reason for peforming poweroff.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Shutdown.reboot">
|
|||
|
|
<code class="sig-name descname">reboot</code><span class="sig-paren">(</span><em class="sig-param">delay</em>, <em class="sig-param">reason</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Shutdown.reboot" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Reboot the appliance. This method was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minutes after which reboot should start. If 0 is specified, reboot
|
|||
|
|
will start immediately.</p></li>
|
|||
|
|
<li><p><strong>reason</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Reason for peforming reboot.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.SubtaskInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">SubtaskInfo</code><span class="sig-paren">(</span><em class="sig-param">progress=None</em>, <em class="sig-param">result=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">operation=None</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">target=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">cancelable=None</em>, <em class="sig-param">error=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.SubtaskInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SubtaskInfo</span></code> class contains information about one of the subtasks
|
|||
|
|
that makes up an appliance task. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) – Progress of the operation. This attribute was added in vSphere API
|
|||
|
|
6.7.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>result</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Notifications" title="com.vmware.appliance_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Result of the operation. If an operation reports partial results
|
|||
|
|
before it completes, this attribute could be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> before
|
|||
|
|
the null has the value
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>. The value
|
|||
|
|
could change as the operation progresses. This attribute was added
|
|||
|
|
in vSphere API 6.7.
|
|||
|
|
This attribute will be None if result is not available at the
|
|||
|
|
current step of the operation.</p></li>
|
|||
|
|
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
|
|||
|
|
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
|||
|
|
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
|||
|
|
<li><p><strong>parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent of the current task.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
|
|||
|
|
as a return value, the attribute will be an identifier for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
|
|||
|
|
This attribute will be None if the task has no parent.</p></li>
|
|||
|
|
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
|
|||
|
|
one the operation performed on.
|
|||
|
|
This attribute will be None if the operation has no target or
|
|||
|
|
multiple targets.</p></li>
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
|
|||
|
|
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
|
|||
|
|
value may change as the operation progresses.</p></li>
|
|||
|
|
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
|
|||
|
|
If None the description of why the operation failed will be
|
|||
|
|
included in the result of the operation (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</p></li>
|
|||
|
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the user who performed the operation.
|
|||
|
|
This attribute will be None if the operation is performed by the
|
|||
|
|
system.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.TaskInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">TaskInfo</code><span class="sig-paren">(</span><em class="sig-param">progress=None</em>, <em class="sig-param">subtask_order=None</em>, <em class="sig-param">subtasks=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">operation=None</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">target=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">cancelable=None</em>, <em class="sig-param">error=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.TaskInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">TaskInfo</span></code> class contains information about an appliance task and the
|
|||
|
|
subtasks of which it consists. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) – Progress of the task. This attribute was added in vSphere API 6.7.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>subtask_order</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of tasks that make up this appliance task in the order they
|
|||
|
|
are being run. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>subtasks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.appliance_client.SubtaskInfo" title="com.vmware.appliance_client.SubtaskInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubtaskInfo</span></code></a>) – Information about the subtasks that this appliance task consists
|
|||
|
|
of. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
|
|||
|
|
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
|||
|
|
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
|||
|
|
<li><p><strong>parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent of the current task.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
|
|||
|
|
as a return value, the attribute will be an identifier for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
|
|||
|
|
This attribute will be None if the task has no parent.</p></li>
|
|||
|
|
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
|
|||
|
|
one the operation performed on.
|
|||
|
|
This attribute will be None if the operation has no target or
|
|||
|
|
multiple targets.</p></li>
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
|
|||
|
|
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
|
|||
|
|
value may change as the operation progresses.</p></li>
|
|||
|
|
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
|
|||
|
|
If None the description of why the operation failed will be
|
|||
|
|
included in the result of the operation (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</p></li>
|
|||
|
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the user who performed the operation.
|
|||
|
|
This attribute will be None if the operation is performed by the
|
|||
|
|
system.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">Timesync</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Timesync" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Timesync</span></code> class provides methods Performs time synchronization
|
|||
|
|
configuration. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync.TimeSyncMode">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">TimeSyncMode</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Timesync.TimeSyncMode" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Timesync.TimeSyncMode</span></code> class defines time synchronization modes.
|
|||
|
|
This enumeration was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">TimeSyncMode</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync.TimeSyncMode.DISABLED">
|
|||
|
|
<code class="sig-name descname">DISABLED</code><em class="property"> = TimeSyncMode(string='DISABLED')</em><a class="headerlink" href="#com.vmware.appliance_client.Timesync.TimeSyncMode.DISABLED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Time synchronization is disabled. This class attribute was added in vSphere
|
|||
|
|
API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync.TimeSyncMode.HOST">
|
|||
|
|
<code class="sig-name descname">HOST</code><em class="property"> = TimeSyncMode(string='HOST')</em><a class="headerlink" href="#com.vmware.appliance_client.Timesync.TimeSyncMode.HOST" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>VMware Tool-based time synchronization. This class attribute was added in
|
|||
|
|
vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync.TimeSyncMode.NTP">
|
|||
|
|
<code class="sig-name descname">NTP</code><em class="property"> = TimeSyncMode(string='NTP')</em><a class="headerlink" href="#com.vmware.appliance_client.Timesync.TimeSyncMode.NTP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>NTP-based time synchronization. This class attribute was added in vSphere
|
|||
|
|
API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Timesync.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get time synchronization mode. This method was added in vSphere API
|
|||
|
|
6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance_client.Timesync.TimeSyncMode" title="com.vmware.appliance_client.Timesync.TimeSyncMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Timesync.TimeSyncMode</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Time synchronization mode.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync.set">
|
|||
|
|
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">mode</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Timesync.set" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set time synchronization mode. This method was added in vSphere API
|
|||
|
|
6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>mode</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Timesync.TimeSyncMode" title="com.vmware.appliance_client.Timesync.TimeSyncMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Timesync.TimeSyncMode</span></code></a>) – Time synchronization mode.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance_client.</code><code class="sig-name descname">Update</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Update</span></code> class provides methods to get the status of the appliance
|
|||
|
|
update. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">state=None</em>, <em class="sig-param">task=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">latest_query_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Update.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Update.Info</span></code> class describes the state of the appliance update. This
|
|||
|
|
class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Update.State" title="com.vmware.appliance_client.Update.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Update.State</span></code></a>) – State of the appliance update. This attribute was added in vSphere
|
|||
|
|
API 6.7.</p></li>
|
|||
|
|
<li><p><strong>task</strong> (<a class="reference internal" href="#com.vmware.appliance_client.TaskInfo" title="com.vmware.appliance_client.TaskInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">TaskInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The running or completed update task. This attribute was added in
|
|||
|
|
vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of base appliance if state is UP_TO_DATE Version of update
|
|||
|
|
being staged or installed if state is INSTALL_IN_PROGRESS or
|
|||
|
|
STAGE_IN_PROGRESS Version of update staged if state is
|
|||
|
|
UPDATES_PENDING Version of update failed if state is INSTALL_FAILED
|
|||
|
|
or ROLLBACK_IN_PROGRESS. This attribute was added in vSphere API
|
|||
|
|
6.7.</p></li>
|
|||
|
|
<li><p><strong>latest_query_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Timestamp of latest query to update repository. This attribute was
|
|||
|
|
added in vSphere API 6.7.
|
|||
|
|
If None the update was never queried</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Update.State" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Update.State</span></code> class defines the various states the appliance update
|
|||
|
|
can be in. This enumeration was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State.INSTALL_FAILED">
|
|||
|
|
<code class="sig-name descname">INSTALL_FAILED</code><em class="property"> = State(string='INSTALL_FAILED')</em><a class="headerlink" href="#com.vmware.appliance_client.Update.State.INSTALL_FAILED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The appliance update failed and cannot recover. This class attribute was
|
|||
|
|
added in vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State.INSTALL_IN_PROGRESS">
|
|||
|
|
<code class="sig-name descname">INSTALL_IN_PROGRESS</code><em class="property"> = State(string='INSTALL_IN_PROGRESS')</em><a class="headerlink" href="#com.vmware.appliance_client.Update.State.INSTALL_IN_PROGRESS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The appliance update is in progress of installing an update. This class
|
|||
|
|
attribute was added in vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State.ROLLBACK_IN_PROGRESS">
|
|||
|
|
<code class="sig-name descname">ROLLBACK_IN_PROGRESS</code><em class="property"> = State(string='ROLLBACK_IN_PROGRESS')</em><a class="headerlink" href="#com.vmware.appliance_client.Update.State.ROLLBACK_IN_PROGRESS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The appliance update failed and recovery is in progress. This class
|
|||
|
|
attribute was added in vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State.STAGE_IN_PROGRESS">
|
|||
|
|
<code class="sig-name descname">STAGE_IN_PROGRESS</code><em class="property"> = State(string='STAGE_IN_PROGRESS')</em><a class="headerlink" href="#com.vmware.appliance_client.Update.State.STAGE_IN_PROGRESS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The appliance update is in progress of downloading an update. This class
|
|||
|
|
attribute was added in vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State.UPDATES_PENDING">
|
|||
|
|
<code class="sig-name descname">UPDATES_PENDING</code><em class="property"> = State(string='UPDATES_PENDING')</em><a class="headerlink" href="#com.vmware.appliance_client.Update.State.UPDATES_PENDING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>A new update is available. This class attribute was added in vSphere API
|
|||
|
|
6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State.UP_TO_DATE">
|
|||
|
|
<code class="sig-name descname">UP_TO_DATE</code><em class="property"> = State(string='UP_TO_DATE')</em><a class="headerlink" href="#com.vmware.appliance_client.Update.State.UP_TO_DATE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The appliance is up to date. This class attribute was added in vSphere API
|
|||
|
|
6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.cancel">
|
|||
|
|
<code class="sig-name descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Update.cancel" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Request the cancellation the update operation that is currently in
|
|||
|
|
progress. This method was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
Current task is not cancellable</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
session is not authenticated</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
session is not authorized to perform this operation</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Update.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Gets the current status of the appliance update. This method was added
|
|||
|
|
in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance_client.Update.Info" title="com.vmware.appliance_client.Update.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Update.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Info structure containing the status information about the
|
|||
|
|
appliance.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
session is not authenticated</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
session is not authorized to perform this operation</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</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 <code class="docutils literal notranslate"><span class="pre">com.vmware.cis_client</span></code> module provides VMware common infrastructure
|
|||
|
|
classes.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.cis_client.Session">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis_client.</code><code class="sig-name descname">Session</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis_client.Session" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Session</span></code> class allows API clients to manage session tokens including
|
|||
|
|
creating, deleting and obtaining information about sessions.</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The <a class="reference internal" href="#com.vmware.cis_client.Session.create" title="com.vmware.cis_client.Session.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Session.create()</span></code></a> method creates session token in exchange for
|
|||
|
|
another authentication token.</p></li>
|
|||
|
|
<li><p>The <a class="reference internal" href="#com.vmware.cis_client.Session.delete" title="com.vmware.cis_client.Session.delete"><code class="xref py py-func docutils literal notranslate"><span class="pre">Session.delete()</span></code></a> method invalidates a session token.</p></li>
|
|||
|
|
<li><p>The <a class="reference internal" href="#com.vmware.cis_client.Session.get" title="com.vmware.cis_client.Session.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Session.get()</span></code></a> retrieves information about a session token.</p></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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Session.create()</span></code></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><p>Connect to lookup service.</p></li>
|
|||
|
|
<li><p>Discover the secure token service (STS) endpoint URL.</p></li>
|
|||
|
|
<li><p>Connect to the secure token service to obtain a SAML token.</p></li>
|
|||
|
|
<li><p>Authenticate to the lookup service using the obtained SAML token.</p></li>
|
|||
|
|
<li><p>Discover the API endpoint URL from lookup service.</p></li>
|
|||
|
|
<li><p>Call the <a class="reference internal" href="#com.vmware.cis_client.Session.create" title="com.vmware.cis_client.Session.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Session.create()</span></code></a> method. The <a class="reference internal" href="#com.vmware.cis_client.Session.create" title="com.vmware.cis_client.Session.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Session.create()</span></code></a> call
|
|||
|
|
must include the SAML token.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<p>See the programming guide and samples for additional information about
|
|||
|
|
establishing API sessions.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p><strong>Execution Context and Security Context</strong></p>
|
|||
|
|
</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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Session.create()</span></code></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><p><strong>Session Lifetime</strong></p>
|
|||
|
|
</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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Session.create()</span></code></a> method to exchange
|
|||
|
|
a SAML token for a API session token. A session ends under the following
|
|||
|
|
circumstances:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Call to the <a class="reference internal" href="#com.vmware.cis_client.Session.delete" title="com.vmware.cis_client.Session.delete"><code class="xref py py-func docutils literal notranslate"><span class="pre">Session.delete()</span></code></a> method.</p></li>
|
|||
|
|
<li><p>The session expires. Session expiration may be caused by one of the
|
|||
|
|
following situations:</p></li>
|
|||
|
|
<li><p>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.</p></li>
|
|||
|
|
<li><p>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.</p></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Session</span></code></a> returns the following exceptions:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a> exception for
|
|||
|
|
any exceptions related to the request.</p></li>
|
|||
|
|
<li><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a> exception
|
|||
|
|
for all exceptions caused by internal service failure.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.cis_client.Session.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">user=None</em>, <em class="sig-param">created_time=None</em>, <em class="sig-param">last_accessed_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis_client.Session.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Represents data associated with an API session.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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.</p></li>
|
|||
|
|
<li><p><strong>created_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the session was created.</p></li>
|
|||
|
|
<li><p><strong>last_accessed_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Last time this session was used by passing the session key for
|
|||
|
|
invoking an API.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.cis_client.Session.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Newly created session identifier to be used for authenticating
|
|||
|
|
further requests.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the 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><p>the supplied token is delegate-able.</p></li>
|
|||
|
|
<li><p>the time of client and server system are synchronized.</p></li>
|
|||
|
|
<li><p>the token supplied is valid.</p></li>
|
|||
|
|
<li><p>if bearer tokens are used check that system configuration allows
|
|||
|
|
the API endpoint to accept such tokens.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.cis_client.Session.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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><p>A session identifier is expected as part of the request.</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the session id is missing from the request or the corresponding
|
|||
|
|
session object cannot be found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
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.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.cis_client.Session.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.cis_client.Session.Info" title="com.vmware.cis_client.Session.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Session.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Information about the session.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the session id is missing from the request or the corresponding
|
|||
|
|
session object cannot be found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
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.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.cis_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.cis_client.Tasks">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis_client.</code><code class="sig-name descname">Tasks</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis_client.Tasks" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Tasks</span></code> class provides methods for managing the task related to a
|
|||
|
|
long running operation. This class was added in vSphere API 6.7.1.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.cis_client.Tasks.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">tasks=None</em>, <em class="sig-param">services=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">targets=None</em>, <em class="sig-param">users=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis_client.Tasks.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Tasks.FilterSpec</span></code> class contains attributes used to filter the
|
|||
|
|
results when listing tasks (see <a class="reference internal" href="#com.vmware.cis_client.Tasks.list" title="com.vmware.cis_client.Tasks.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tasks.list()</span></code></a>). If multiple attributes
|
|||
|
|
are specified, only tasks matching all of the attributes match the filter.</p>
|
|||
|
|
<p>Currently at least one of <code class="xref py py-attr docutils literal notranslate"><span class="pre">Tasks.FilterSpec.tasks</span></code> or
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Tasks.FilterSpec.services</span></code> must be specified and not empty.. This
|
|||
|
|
class was added in vSphere API 6.7.1.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>tasks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers of tasks that can match the filter. This attribute was
|
|||
|
|
added in vSphere API 6.7.1.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
|
|||
|
|
as a return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
|
|||
|
|
This attribute may be None if <code class="docutils literal notranslate"><span class="pre">services</span></code> is specified. Currently
|
|||
|
|
all tasks must be from the same provider. If None or empty, tasks
|
|||
|
|
with any identifier will match the filter.</p></li>
|
|||
|
|
<li><p><strong>services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers of services. Tasks created by operations in these
|
|||
|
|
services match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.CommonInfo.service</span></code>). This
|
|||
|
|
attribute was added in vSphere API 6.7.1.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will contain identifiers for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.
|
|||
|
|
This attribute may be None if <code class="docutils literal notranslate"><span class="pre">tasks</span></code> is specified. Currently all
|
|||
|
|
services must be from the same provider. If this attribute is None
|
|||
|
|
or empty, tasks for any service will match the filter.</p></li>
|
|||
|
|
<li><p><strong>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Status that a task must have to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.CommonInfo.status</span></code>). This
|
|||
|
|
attribute was added in vSphere API 6.7.1.
|
|||
|
|
If None or empty, tasks with any status match the filter.</p></li>
|
|||
|
|
<li><p><strong>targets</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers of the targets the operation for the associated task
|
|||
|
|
created or was performed on (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.CommonInfo.target</span></code>). This
|
|||
|
|
attribute was added in vSphere API 6.7.1.
|
|||
|
|
If None or empty, tasks associated with operations on any target
|
|||
|
|
match the filter.</p></li>
|
|||
|
|
<li><p><strong>users</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Users who must have initiated the operation for the associated task
|
|||
|
|
to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.CommonInfo.user</span></code>). This attribute
|
|||
|
|
was added in vSphere API 6.7.1.
|
|||
|
|
If None or empty, tasks associated with operations initiated by any
|
|||
|
|
user match the filter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.cis_client.Tasks.GetSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">GetSpec</code><span class="sig-paren">(</span><em class="sig-param">return_all=None</em>, <em class="sig-param">exclude_result=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis_client.Tasks.GetSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Tasks.GetSpec</span></code> class describes what data should be included when
|
|||
|
|
retrieving information about a task. This class was added in vSphere API
|
|||
|
|
6.7.1.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>return_all</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If true, all data, including operation-specific data, will be
|
|||
|
|
returned, otherwise only the data described in
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Info" title="com.vmware.cis.task_client.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info</span></code></a> will be returned. This
|
|||
|
|
attribute was added in vSphere API 6.7.1.
|
|||
|
|
If None, only the data described in
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Info" title="com.vmware.cis.task_client.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info</span></code></a> will be returned.</p></li>
|
|||
|
|
<li><p><strong>exclude_result</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If true, the result will not be included in the task information,
|
|||
|
|
otherwise it will be included. This attribute was added in vSphere
|
|||
|
|
API 6.7.1.
|
|||
|
|
If None, the result of the operation will be included in the task
|
|||
|
|
information.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.cis_client.Tasks.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.cis.task'</em><a class="headerlink" href="#com.vmware.cis_client.Tasks.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Resource type for task. This class attribute was added in vSphere API 6.7.1.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.cis_client.Tasks.cancel">
|
|||
|
|
<code class="sig-name descname">cancel</code><span class="sig-paren">(</span><em class="sig-param">task</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis_client.Tasks.cancel" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Cancel a running operation associated with the task. This is the best
|
|||
|
|
effort attempt. Operation may not be cancelled anymore once it reaches
|
|||
|
|
certain stage. This method was added in vSphere API 6.7.1.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Task identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the task is already canceled or completed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the task is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the task’s state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the task is not cancelable.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.cis_client.Tasks.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">task</em>, <em class="sig-param">spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis_client.Tasks.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about a task. This method was added in vSphere API
|
|||
|
|
6.7.1.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Task identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.</p></li>
|
|||
|
|
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.cis_client.Tasks.GetSpec" title="com.vmware.cis_client.Tasks.GetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tasks.GetSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification on what to get for a task.
|
|||
|
|
If None, the behavior is equivalent to a <a class="reference internal" href="#com.vmware.cis_client.Tasks.GetSpec" title="com.vmware.cis_client.Tasks.GetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tasks.GetSpec</span></code></a>
|
|||
|
|
with all attributes None which means only the data described in
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Info" title="com.vmware.cis.task_client.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info</span></code></a> will be returned and the
|
|||
|
|
result of the operation will be return.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Info" title="com.vmware.cis.task_client.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the specified task.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the task is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the task’s state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.cis_client.Tasks.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter_spec=None</em>, <em class="sig-param">result_spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis_client.Tasks.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
|||
|
|
checks) tasks matching the <a class="reference internal" href="#com.vmware.cis_client.Tasks.FilterSpec" title="com.vmware.cis_client.Tasks.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tasks.FilterSpec</span></code></a>. All tasks must be
|
|||
|
|
in the same provider. This method was added in vSphere API 6.7.1.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>filter_spec</strong> (<a class="reference internal" href="#com.vmware.cis_client.Tasks.FilterSpec" title="com.vmware.cis_client.Tasks.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tasks.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of matching tasks.
|
|||
|
|
This is currently required. In the future, if it is None, the
|
|||
|
|
behavior is equivalent to a <a class="reference internal" href="#com.vmware.cis_client.Tasks.FilterSpec" title="com.vmware.cis_client.Tasks.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tasks.FilterSpec</span></code></a> with all
|
|||
|
|
attributes None which means all tasks match the filter.</p></li>
|
|||
|
|
<li><p><strong>result_spec</strong> (<a class="reference internal" href="#com.vmware.cis_client.Tasks.GetSpec" title="com.vmware.cis_client.Tasks.GetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tasks.GetSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of what to return for a task.
|
|||
|
|
If None, the behavior is equivalent to a <a class="reference internal" href="#com.vmware.cis_client.Tasks.GetSpec" title="com.vmware.cis_client.Tasks.GetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tasks.GetSpec</span></code></a>
|
|||
|
|
with all attributes None which means only the data describe in
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Info" title="com.vmware.cis.task_client.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info</span></code></a> will be returned and the
|
|||
|
|
result of the operation will be return.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Info" title="com.vmware.cis.task_client.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Map of task identifier to information about the task.
|
|||
|
|
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if any of the specified parameters are invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if a task’s state cannot be accessed or over 1000 tasks matching
|
|||
|
|
the <a class="reference internal" href="#com.vmware.cis_client.Tasks.FilterSpec" title="com.vmware.cis_client.Tasks.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tasks.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</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><code class="sig-prename descclassname">com.vmware.content_client.</code><code class="sig-name descname">Configuration</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Configuration" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Configuration</span></code> 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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Configuration.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModel</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>The <a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModel</span></code></a> instance representing the
|
|||
|
|
configuration of the Content Library Service.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">ContentLibrary.GetConfiguration</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Configuration.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModel</span></code></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>model</strong> (<a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModel</span></code></a>) – The <a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModel</span></code></a> specifying the settings to update.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if one of the configuration properties is not within the proper
|
|||
|
|
range.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">ContentLibrary.UpdateConfiguration</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.ConfigurationModel">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content_client.</code><code class="sig-name descname">ConfigurationModel</code><span class="sig-paren">(</span><em class="sig-param">automatic_sync_enabled=None</em>, <em class="sig-param">automatic_sync_start_hour=None</em>, <em class="sig-param">automatic_sync_stop_hour=None</em>, <em class="sig-param">maximum_concurrent_item_syncs=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.ConfigurationModel" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ConfigurationModel</span></code> class defines the global settings of the Content
|
|||
|
|
Library Service.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>automatic_sync_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – <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
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.automatic_sync_enabled</span></code>
|
|||
|
|
flag turned on will be synchronized every hour between
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ConfigurationModel.automatic_sync_start_hour</span></code> and
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ConfigurationModel.automatic_sync_stop_hour</span></code>.
|
|||
|
|
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
|
|||
|
|
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
|
|||
|
|
methods. It is optional for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>automatic_sync_start_hour</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – 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 <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
|
|||
|
|
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
|
|||
|
|
methods. It is optional for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
|
|||
|
|
<li><p><strong>automatic_sync_stop_hour</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – 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 <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
|
|||
|
|
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
|
|||
|
|
methods. It is optional for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
|
|||
|
|
<li><p><strong>maximum_concurrent_item_syncs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – <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><p>This setting is global across all subscribed libraries.</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<p>This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
|
|||
|
|
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
|
|||
|
|
methods. It is optional for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p>
|
|||
|
|
</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.Library">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content_client.</code><code class="sig-name descname">Library</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Library" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Library</span></code> class provides methods to manage and find
|
|||
|
|
<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a> entities.</p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Library</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalLibrary</span></code></a> and <a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary" title="com.vmware.content_client.SubscribedLibrary"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubscribedLibrary</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.Library.FindSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FindSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Library.FindSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the library to search. The name is case-insensitive. See
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.name</span></code>.
|
|||
|
|
If not specified any name will be searched.</p></li>
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel.LibraryType" title="com.vmware.content_client.LibraryModel.LibraryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel.LibraryType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Library type to search. See <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.type</span></code>.
|
|||
|
|
If not specified any library type will be searched.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.Library.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><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">
|
|||
|
|
<code class="sig-name descname">find</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Library.FindSpec</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.content_client.Library.FindSpec" title="com.vmware.content_client.Library.FindSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Library.FindSpec</span></code></a>) – Specification describing what properties to filter on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content_client.Library.list" title="com.vmware.content_client.Library.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content_client.Library.list" title="com.vmware.content_client.Library.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of identifiers of all the visible libraries
|
|||
|
|
matching the given <code class="docutils literal notranslate"><span class="pre">spec</span></code>.
|
|||
|
|
The return value will contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if no properties are specified in the <code class="docutils literal notranslate"><span class="pre">spec</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Library.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">library_id</em><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the library to return.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a> instance with the specified
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">library_id</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the specified library does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
|||
|
|
parameter <code class="docutils literal notranslate"><span class="pre">library_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Library.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.content_client.Library.list" title="com.vmware.content_client.Library.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>The <a class="reference internal" href="#com.vmware.content_client.Library.list" title="com.vmware.content_client.Library.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of all identifiers of all libraries in the
|
|||
|
|
Content Library.
|
|||
|
|
The return value will contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Library.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">library_id</em>, <em class="sig-param">update_spec</em><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></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
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.publish_info</span></code> of a local library, nor the
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.subscription_info</span></code> 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"><code class="xref py py-func docutils literal notranslate"><span class="pre">LocalLibrary.update()</span></code></a> and
|
|||
|
|
<a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.update" title="com.vmware.content_client.SubscribedLibrary.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">SubscribedLibrary.update()</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the library to update.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p></li>
|
|||
|
|
<li><p><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a>) – Specification of the new property values to set on the library.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the library associated with <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.version</span></code> of <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is not equal
|
|||
|
|
to the current version of the library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
|||
|
|
parameter <code class="docutils literal notranslate"><span class="pre">library_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">ContentLibrary.UpdateLibrary</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.LibraryModel">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content_client.</code><code class="sig-name descname">LibraryModel</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">creation_time=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">last_modified_time=None</em>, <em class="sig-param">last_sync_time=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">storage_backings=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">optimization_info=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">publish_info=None</em>, <em class="sig-param">subscription_info=None</em>, <em class="sig-param">server_guid=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.LibraryModel" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a> class represents a Content Library resource
|
|||
|
|
model.</p>
|
|||
|
|
<p>A <code class="docutils literal notranslate"><span class="pre">LibraryModel</span></code> 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 <code class="docutils literal notranslate"><span class="pre">LibraryModel</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.ItemModel</span></code></a> instances. Each item
|
|||
|
|
is a logical object in a library, which may have multiple files.</p>
|
|||
|
|
<p>A <code class="docutils literal notranslate"><span class="pre">LibraryModel</span></code> 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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – An identifier which uniquely identifies this <code class="docutils literal notranslate"><span class="pre">LibraryModel</span></code>.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.
|
|||
|
|
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will not
|
|||
|
|
be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code> methods.
|
|||
|
|
It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
|
|||
|
|
<li><p><strong>creation_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The date and time when this library was created.
|
|||
|
|
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
|
|||
|
|
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
|
|||
|
|
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A human-readable description for this library.
|
|||
|
|
This attribute is optional for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. Leaving it
|
|||
|
|
None during creation will result in an empty string value. It will
|
|||
|
|
always be present in the result of a <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code> method. It
|
|||
|
|
is optional for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method. Leaving it None during
|
|||
|
|
update indicates that the description should be left unchanged.</p></li>
|
|||
|
|
<li><p><strong>last_modified_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – <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 <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
|
|||
|
|
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
|
|||
|
|
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>last_sync_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – <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 <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It is
|
|||
|
|
optional in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code> methods. It
|
|||
|
|
is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <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 <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
|
|||
|
|
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
|
|||
|
|
methods. It is optional for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>storage_backings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.StorageBacking" title="com.vmware.content.library_client.StorageBacking"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.StorageBacking</span></code></a>) – <p>The list of default 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.StorageBacking</span></code></a> defines
|
|||
|
|
a default storage location which can be used to store files for
|
|||
|
|
library items in this library. Some library items, for instance,
|
|||
|
|
virtual machine template items, support files that may be
|
|||
|
|
distributed across various storage backings. One or more item files
|
|||
|
|
may or may not be located on the default storage backing.</p>
|
|||
|
|
<p>Multiple default storage locations are not currently supported but
|
|||
|
|
may become supported in future releases.
|
|||
|
|
This attribute must be provided for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
|
|||
|
|
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
|
|||
|
|
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel.LibraryType" title="com.vmware.content_client.LibraryModel.LibraryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel.LibraryType</span></code></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 is
|
|||
|
|
not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> and <code class="docutils literal notranslate"><span class="pre">update</span></code> methods. It will always
|
|||
|
|
be present in the result of a <code class="docutils literal notranslate"><span class="pre">get</span></code> method.
|
|||
|
|
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
|
|||
|
|
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
|
|||
|
|
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.OptimizationInfo</span></code></a>) – Defines various optimizations and optimization parameters applied
|
|||
|
|
to this library.
|
|||
|
|
This attribute is optional for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It is
|
|||
|
|
optional in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code> methods. It
|
|||
|
|
is optional for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
|
|||
|
|
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <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 <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
|
|||
|
|
always be present in the result of a <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code> method. It
|
|||
|
|
is optional for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method. Leaving it None during
|
|||
|
|
update indicates that you do not need to detect concurrent updates.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.PublishInfo</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.PublishInfo</span></code></a> defines
|
|||
|
|
where and how the metadata for this local library is accessible. A
|
|||
|
|
local library is only published publically if
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.PublishInfo.published</span></code> is
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">true</span></code>.
|
|||
|
|
This attribute is optional for the <code class="docutils literal notranslate"><span class="pre">create</span></code> and <code class="docutils literal notranslate"><span class="pre">update</span></code>
|
|||
|
|
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>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.SubscriptionInfo</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.SubscriptionInfo</span></code></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
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.automatic_sync_enabled</span></code>
|
|||
|
|
to false will halt subscription but will not remove existing cached
|
|||
|
|
data.
|
|||
|
|
This attribute is optional for the <code class="docutils literal notranslate"><span class="pre">create</span></code> and <code class="docutils literal notranslate"><span class="pre">update</span></code>
|
|||
|
|
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>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>server_guid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter</span></code>.
|
|||
|
|
This attribute is optional for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
|
|||
|
|
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
|
|||
|
|
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.LibraryModel.LibraryType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">LibraryType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.LibraryModel.LibraryType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryModel.LibraryType</span></code> class defines the type of a
|
|||
|
|
<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></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="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.LibraryModel.LibraryType.LOCAL">
|
|||
|
|
<code class="sig-name descname">LOCAL</code><em class="property"> = LibraryType(string='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"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalLibrary</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.LibraryModel.LibraryType.SUBSCRIBED">
|
|||
|
|
<code class="sig-name descname">SUBSCRIBED</code><em class="property"> = LibraryType(string='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"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubscribedLibrary</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content_client.</code><code class="sig-name descname">LocalLibrary</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.LocalLibrary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalLibrary</span></code> class manages local libraries.</p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalLibrary</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Library</span></code></a>
|
|||
|
|
class to manage general library functionality.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary.DestinationSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">DestinationSpec</code><span class="sig-paren">(</span><em class="sig-param">subscription=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.LocalLibrary.DestinationSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalLibrary.DestinationSpec</span></code> class contains information required to
|
|||
|
|
publish the library to a specific subscription. This class was added in
|
|||
|
|
vSphere API 6.7.2.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>subscription</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the subscription associated with the subscribed
|
|||
|
|
library. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Subscriptions</span></code>. When methods return a
|
|||
|
|
value of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Subscriptions</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">create_spec</em>, <em class="sig-param">client_token=None</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>client_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A unique token generated on the client for each creation request.
|
|||
|
|
The token should be a universally unique identifier (UUID), for
|
|||
|
|
example: <code class="docutils literal notranslate"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
|
|||
|
|
be used to guarantee idempotent creation.
|
|||
|
|
If not specified creation is not idempotent.</p></li>
|
|||
|
|
<li><p><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a>) – Specification for the new local library.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Identifier of the newly created <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a>.
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">create_spec</span></code> is not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">client_token</span></code> does not conform to the UUID format.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if using multiple storage backings.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">ContentLibrary.CreateLocalLibrary</span></code>.</p></li>
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.StorageBacking.datastore_id</span></code>
|
|||
|
|
requires <code class="docutils literal notranslate"><span class="pre">Datastore.AllocateSpace</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">library_id</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the local library to delete.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a local library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the library contains a library item that cannot be deleted in
|
|||
|
|
its current state. For example, the library item contains a virtual
|
|||
|
|
machine template and a virtual machine is checked out of the
|
|||
|
|
library item.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
|||
|
|
parameter <code class="docutils literal notranslate"><span class="pre">library_id</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.DeleteLocalLibrary</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">library_id</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the local library to return.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a> instance associated with <code class="docutils literal notranslate"><span class="pre">library_id</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a local library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
|||
|
|
parameter <code class="docutils literal notranslate"><span class="pre">library_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.content_client.LocalLibrary.list" title="com.vmware.content_client.LocalLibrary.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>The <a class="reference internal" href="#com.vmware.content_client.LocalLibrary.list" title="com.vmware.content_client.LocalLibrary.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of identifiers of all local libraries in the
|
|||
|
|
Content Library.
|
|||
|
|
The return value will contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary.publish">
|
|||
|
|
<code class="sig-name descname">publish</code><span class="sig-paren">(</span><em class="sig-param">library_id</em>, <em class="sig-param">subscriptions=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.LocalLibrary.publish" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Publishes the library to specified subscriptions. If no subscriptions
|
|||
|
|
are specified, then publishes the library to all its subscriptions.
|
|||
|
|
This method was added in vSphere API 6.7.2.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the published library.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p></li>
|
|||
|
|
<li><p><strong>subscriptions</strong> (<a class="reference internal" href="#com.vmware.content_client.LocalLibrary.list" title="com.vmware.content_client.LocalLibrary.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content_client.LocalLibrary.DestinationSpec" title="com.vmware.content_client.LocalLibrary.DestinationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalLibrary.DestinationSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The list of subscriptions to publish this library to.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
If the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
If one or more <code class="docutils literal notranslate"><span class="pre">subscriptions</span></code> is not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code></a>
|
|||
|
|
If the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is a subscribed library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
If the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a published
|
|||
|
|
library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
If the user that requested the method cannot be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
If the user that requested the method is not authorized to perform
|
|||
|
|
the method.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
|||
|
|
parameter <code class="docutils literal notranslate"><span class="pre">library_id</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.PublishLibrary</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">library_id</em>, <em class="sig-param">update_spec</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the local library to update.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p></li>
|
|||
|
|
<li><p><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a>) – Specification of the new property values to set on the local
|
|||
|
|
library.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is a published library
|
|||
|
|
with JSON persistence enabled (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.PublishInfo.persist_json_enabled</span></code>)
|
|||
|
|
and the content of the library has been deleted from the storage
|
|||
|
|
backings (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.storage_backings</span></code>) associated
|
|||
|
|
with it.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a local library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.PublishInfo.current_password</span></code>
|
|||
|
|
in the <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> does not match the existing password of the
|
|||
|
|
published library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.version</span></code> of <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is None and
|
|||
|
|
the library is being concurrently updated by another user.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ConcurrentChange" title="com.vmware.vapi.std.errors_client.ConcurrentChange"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ConcurrentChange</span></code></a>
|
|||
|
|
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.version</span></code> of <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is not equal
|
|||
|
|
to the current version of the library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
|||
|
|
parameter <code class="docutils literal notranslate"><span class="pre">library_id</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.UpdateLocalLibrary</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content_client.</code><code class="sig-name descname">SubscribedLibrary</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ProbeResult</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">ssl_thumbprint=None</em>, <em class="sig-param">error_messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SubscribedLibrary.ProbeResult</span></code> 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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status" title="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubscribedLibrary.ProbeResult.Status</span></code></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.</p></li>
|
|||
|
|
<li><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The SSL thumbprint for the remote endpoint.
|
|||
|
|
An SSL thumbprint is only returned if the host is secured with
|
|||
|
|
SSL/TLS.</p></li>
|
|||
|
|
<li><p><strong>error_messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – If the probe result is in an error status, this attribute will
|
|||
|
|
contain the detailed error messages.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SubscribedLibrary.ProbeResult.Status</span></code> class defines the error status
|
|||
|
|
constants for the probe result.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.CERTIFICATE_ERROR">
|
|||
|
|
<code class="sig-name descname">CERTIFICATE_ERROR</code><em class="property"> = Status(string='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
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.ssl_thumbprint</span></code>
|
|||
|
|
is invalid. In this case, the returned null should be set in
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.ssl_thumbprint</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.HOST_NOT_FOUND">
|
|||
|
|
<code class="sig-name descname">HOST_NOT_FOUND</code><em class="property"> = Status(string='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">
|
|||
|
|
<code class="sig-name descname">INVALID_CREDENTIALS</code><em class="property"> = Status(string='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">
|
|||
|
|
<code class="sig-name descname">INVALID_URL</code><em class="property"> = Status(string='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">
|
|||
|
|
<code class="sig-name descname">RESOURCE_NOT_FOUND</code><em class="property"> = Status(string='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">
|
|||
|
|
<code class="sig-name descname">SUCCESS</code><em class="property"> = Status(string='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">
|
|||
|
|
<code class="sig-name descname">TIMED_OUT</code><em class="property"> = Status(string='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">
|
|||
|
|
<code class="sig-name descname">UNKNOWN_ERROR</code><em class="property"> = Status(string='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"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubscribedLibrary.ProbeResult.Status</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">create_spec</em>, <em class="sig-param">client_token=None</em><span class="sig-paren">)</span><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
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.subscription_info</span></code> 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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>client_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique token generated on the client for each creation request. The
|
|||
|
|
token should be a universally unique identifier (UUID), for
|
|||
|
|
example: <code class="docutils literal notranslate"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
|
|||
|
|
be used to guarantee idempotent creation.
|
|||
|
|
If not specified creation is not idempotent.</p></li>
|
|||
|
|
<li><p><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a>) – Specification for the new subscribed library.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Identifier of the newly created subscribed library.
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">create_spec</span></code> is not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">client_token</span></code> does not conform to the UUID format.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if using multiple storage backings.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if subscribing to a published library which cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.CreateSubscribedLibrary</span></code>.</p></li>
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.StorageBacking.datastore_id</span></code>
|
|||
|
|
requires <code class="docutils literal notranslate"><span class="pre">Datastore.AllocateSpace</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">library_id</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the subscribed library to delete.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code></a>
|
|||
|
|
if the library referenced by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a subscribed
|
|||
|
|
library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the library referenced by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
|||
|
|
parameter <code class="docutils literal notranslate"><span class="pre">library_id</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.DeleteSubscribedLibrary</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.evict">
|
|||
|
|
<code class="sig-name descname">evict</code><span class="sig-paren">(</span><em class="sig-param">library_id</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the subscribed library whose content should be
|
|||
|
|
evicted.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a subscribed
|
|||
|
|
library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not synchronize
|
|||
|
|
on-demand, or if the content of the library specified by
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">library_id</span></code> has been deleted from the storage backings (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.storage_backings</span></code>) associated with it.</p>
|
|||
|
|
<p>For instance, this {\@term error) is reported on evicting an
|
|||
|
|
on-demand subscribed library that was restored from backup, and the
|
|||
|
|
library was deleted after the backup was taken, thus resulting in
|
|||
|
|
its content being deleted from the associated storage backings. In
|
|||
|
|
this scenario, the metadata of the library is present on a restore,
|
|||
|
|
while its content has been deleted.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
|||
|
|
parameter <code class="docutils literal notranslate"><span class="pre">library_id</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.EvictSubscribedLibrary</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">library_id</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the subscribed library to return.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a> instance that corresponds to
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">library_id</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the library associated with <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code></a>
|
|||
|
|
if the library associated with <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a subscribed
|
|||
|
|
library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
|||
|
|
parameter <code class="docutils literal notranslate"><span class="pre">library_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.list" title="com.vmware.content_client.SubscribedLibrary.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>The <a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.list" title="com.vmware.content_client.SubscribedLibrary.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of identifiers of all subscribed libraries in the
|
|||
|
|
Content Library.
|
|||
|
|
The return value will contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.probe">
|
|||
|
|
<code class="sig-name descname">probe</code><span class="sig-paren">(</span><em class="sig-param">subscription_info</em><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubscribedLibrary.ProbeResult</span></code></a> class describes whether or not
|
|||
|
|
the subscription configuration is successful.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.SubscriptionInfo</span></code></a>) – The subscription info to be probed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult" title="com.vmware.content_client.SubscribedLibrary.ProbeResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubscribedLibrary.ProbeResult</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>The subscription info probe result.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">ContentLibrary.ProbeSubscription</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.sync">
|
|||
|
|
<code class="sig-name descname">sync</code><span class="sig-paren">(</span><em class="sig-param">library_id</em><span class="sig-paren">)</span><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
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.on_demand</span></code>
|
|||
|
|
setting is respected. Calling this method on a library that is already
|
|||
|
|
in the process of synchronizing will have no effect.</p>
|
|||
|
|
<dl class="field-list">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the subscribed library to synchronize.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a subscribed
|
|||
|
|
library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the content of the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> has been
|
|||
|
|
deleted from the storage backings (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.storage_backings</span></code>) associated with it.</p>
|
|||
|
|
<p>For instance, this {\@term error) is reported on synchronizing a
|
|||
|
|
subscribed library that was restored from backup, and the library
|
|||
|
|
was deleted after the backup was taken, thus resulting in its
|
|||
|
|
content being deleted from the associated storage backings. In this
|
|||
|
|
scenario, the metadata of the library is present on a restore,
|
|||
|
|
while its content has been deleted.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if some parameter in the subscribed library subscription info is
|
|||
|
|
invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the published library cannot be contacted or found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
|||
|
|
parameter <code class="docutils literal notranslate"><span class="pre">library_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">ContentLibrary.SyncLibrary</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">library_id</em>, <em class="sig-param">update_spec</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the subscribed library to update.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p></li>
|
|||
|
|
<li><p><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a>) – Specification of the new property values to set on the subscribed
|
|||
|
|
library.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> updates the subscription URL (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.subscription_url</span></code>)
|
|||
|
|
and the content of the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> has been
|
|||
|
|
deleted from the storage backings (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.storage_backings</span></code>) associated with it.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code></a>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a subscribed
|
|||
|
|
library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the subscription info is being updated but the published library
|
|||
|
|
cannot be contacted or found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.version</span></code> of <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is None and
|
|||
|
|
the library is being concurrently updated by another user.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ConcurrentChange" title="com.vmware.vapi.std.errors_client.ConcurrentChange"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ConcurrentChange</span></code></a>
|
|||
|
|
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.version</span></code> of <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is not equal
|
|||
|
|
to the current version of the library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
|
|||
|
|
parameter <code class="docutils literal notranslate"><span class="pre">library_id</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.UpdateSubscribedLibrary</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.Type">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content_client.</code><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Type" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Type</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.ItemModel</span></code></a> types that this
|
|||
|
|
Content Library Service supports.</p>
|
|||
|
|
<p>A library item has an optional type which can be specified with the
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.ItemModel.type</span></code> 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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.Type.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">description=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">vendor=None</em>, <em class="sig-param">version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Type.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Type.Info</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.ItemModel</span></code></a>. The <code class="docutils literal notranslate"><span class="pre">Type.Info</span></code> can
|
|||
|
|
be queried through the <a class="reference internal" href="#com.vmware.content_client.Type" title="com.vmware.content_client.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A description of the type support offered by the plugin.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the plugin which provides the type support.</p></li>
|
|||
|
|
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The type which the plugin supports.</p>
|
|||
|
|
<p>To upload a library item of the type supported by the plugin, the
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.ItemModel.type</span></code> attribute
|
|||
|
|
of the item should be set to this value.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the vendor who created the type support plugin.</p></li>
|
|||
|
|
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version number of the type support plugin.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Type.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content_client.Type.Info" title="com.vmware.content_client.Type.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type.Info</span></code></a> instances which describe
|
|||
|
|
the type support plugins in this Content Library.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.content_client.Type.list" title="com.vmware.content_client.Type.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content_client.Type.Info" title="com.vmware.content_client.Type.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>The <a class="reference internal" href="#com.vmware.content_client.Type.list" title="com.vmware.content_client.Type.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content_client.Type.Info" title="com.vmware.content_client.Type.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type.Info</span></code></a> instances which describe
|
|||
|
|
the type support plugins in this Content Library.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">ContentLibrary.TypeIntrospection</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.vapi_client">
|
|||
|
|
<span id="com-vmware-vapi-client-module"></span><h2>com.vmware.vapi_client module<a class="headerlink" href="#module-com.vmware.vapi_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi_client</span></code> component provides API infrastructure classes
|
|||
|
|
and standard types that can be used in the interface specification of any
|
|||
|
|
class.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vapi_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</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 <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter_client</span></code> 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><code class="sig-prename descclassname">com.vmware.vcenter_client.</code><code class="sig-name descname">Cluster</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Cluster" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster</span></code> class provides methods to manage clusters in the vCenter
|
|||
|
|
Server.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Cluster.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">clusters=None</em>, <em class="sig-param">names=None</em>, <em class="sig-param">folders=None</em>, <em class="sig-param">datacenters=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.FilterSpec</span></code> 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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Cluster.list()</span></code></a>). If multiple
|
|||
|
|
attributes are specified, only clusters matching all of the attributes
|
|||
|
|
match the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>clusters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will contain identifiers for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
|||
|
|
If None or empty, clusters with any identifier match the filter.</p></li>
|
|||
|
|
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names that clusters must have to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.Info.name</span></code>).
|
|||
|
|
If None or empty, clusters with any name match the filter.</p></li>
|
|||
|
|
<li><p><strong>folders</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Folder</span></code>. When methods return a value of this class as a return
|
|||
|
|
value, the attribute will contain identifiers for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
If None or empty, clusters in any folder match the filter.</p></li>
|
|||
|
|
<li><p><strong>datacenters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.
|
|||
|
|
If None or empty, clusters in any datacenter match the filter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Cluster.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">resource_pool=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.Info</span></code> class contains information about a cluster in vCenter
|
|||
|
|
Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the cluster</p></li>
|
|||
|
|
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Cluster.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><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><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">cluster=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">ha_enabled=None</em>, <em class="sig-param">drs_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.Summary</span></code> class contains commonly used information about a
|
|||
|
|
cluster in vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the cluster.</p></li>
|
|||
|
|
<li><p><strong>ha_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the vSphere HA feature is enabled for the
|
|||
|
|
cluster.</p></li>
|
|||
|
|
<li><p><strong>drs_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the vSphere DRS service is enabled for the
|
|||
|
|
cluster.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Cluster.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">cluster</em><span class="sig-paren">)</span><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 <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.Cluster.Info" title="com.vmware.vcenter_client.Cluster.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vcenter_client.Cluster.Info" title="com.vmware.vcenter_client.Cluster.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.Info</span></code></a> instances that corresponds to the
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">cluster</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the session id is missing from the request or the corresponding
|
|||
|
|
session object cannot be found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t not have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Cluster.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.FilterSpec</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="com.vmware.vcenter_client.Cluster.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.FilterSpec</span></code></a> with all attributes None which means
|
|||
|
|
all clusters match the filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.Cluster.list" title="com.vmware.vcenter_client.Cluster.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter_client.Cluster.Summary" title="com.vmware.vcenter_client.Cluster.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if more than 1000 clusters match the <a class="reference internal" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="com.vmware.vcenter_client.Cluster.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter_client.</code><code class="sig-name descname">Datacenter</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code> class provides methods to manage datacenters in the
|
|||
|
|
vCenter Server.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">folder=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datacenter.CreateSpec</span></code> class defines the information used to create
|
|||
|
|
a datacenter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the datacenter to be created.</p></li>
|
|||
|
|
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">datacenters=None</em>, <em class="sig-param">names=None</em>, <em class="sig-param">folders=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datacenter.FilterSpec</span></code> 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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Datacenter.list()</span></code></a>). If multiple
|
|||
|
|
attributes are specified, only datacenters matching all of the attributes
|
|||
|
|
match the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>datacenters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.
|
|||
|
|
If None or empty, datacenters with any identifier match the filter.</p></li>
|
|||
|
|
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names that datacenters must have to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Datacenter.Info.name</span></code>).
|
|||
|
|
If None or empty, datacenters with any name match the filter.</p></li>
|
|||
|
|
<li><p><strong>folders</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Folder</span></code>. When methods return a value of this class as a return
|
|||
|
|
value, the attribute will contain identifiers for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
If None or empty, datacenters in any folder match the filter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">datastore_folder=None</em>, <em class="sig-param">host_folder=None</em>, <em class="sig-param">network_folder=None</em>, <em class="sig-param">vm_folder=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datacenter.Info</span></code> class contains information about a datacenter in
|
|||
|
|
vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the datacenter.</p></li>
|
|||
|
|
<li><p><strong>datastore_folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.</p></li>
|
|||
|
|
<li><p><strong>host_folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.</p></li>
|
|||
|
|
<li><p><strong>network_folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.</p></li>
|
|||
|
|
<li><p><strong>vm_folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><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><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">datacenter=None</em>, <em class="sig-param">name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datacenter.Summary</span></code> class contains commonly used information about a
|
|||
|
|
datacenter in vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>datacenter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the datacenter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.CreateSpec" title="com.vmware.vcenter_client.Datacenter.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.CreateSpec</span></code></a>) – Specification for the new datacenter to be created.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>The identifier of the newly created datacenter
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
if the datacenter with the same name is already present.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the datacenter name is empty or invalid as per the underlying
|
|||
|
|
implementation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the folder is not specified and the system cannot choose a
|
|||
|
|
suitable one.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the datacenter folder cannot be found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">datacenter</em>, <em class="sig-param">force=None</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>datacenter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the datacenter to be deleted.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.</p></li>
|
|||
|
|
<li><p><strong>force</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If true, delete the datacenter even if it is not empty.
|
|||
|
|
If None a <a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
|
|||
|
|
exception will be reported if the datacenter is not empty. This is
|
|||
|
|
the equivalent of passing the value false.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if there is no datacenter associated with <code class="docutils literal notranslate"><span class="pre">datacenter</span></code> in the
|
|||
|
|
system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
|
|||
|
|
if the datacenter associated with <code class="docutils literal notranslate"><span class="pre">datacenter</span></code> is not empty.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">datacenter</em><span class="sig-paren">)</span><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
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">datacenter</span></code>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>datacenter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the datacenter.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.Info" title="com.vmware.vcenter_client.Datacenter.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.Info" title="com.vmware.vcenter_client.Datacenter.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.Info</span></code></a> instances that corresponds to the
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">datacenter</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if there is no datacenter associated with <code class="docutils literal notranslate"><span class="pre">datacenter</span></code> in the
|
|||
|
|
system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.FilterSpec</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="com.vmware.vcenter_client.Datacenter.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.FilterSpec</span></code></a> with all attributes None which means
|
|||
|
|
all datacenters match the filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.list" title="com.vmware.vcenter_client.Datacenter.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.Summary" title="com.vmware.vcenter_client.Datacenter.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if more than 1000 datacenters match the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="com.vmware.vcenter_client.Datacenter.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter_client.</code><code class="sig-name descname">Datastore</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datastore" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The Datastore class provides methods for manipulating a datastore.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">datastores=None</em>, <em class="sig-param">names=None</em>, <em class="sig-param">types=None</em>, <em class="sig-param">folders=None</em>, <em class="sig-param">datacenters=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datastore.FilterSpec</span></code> 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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Datastore.list()</span></code></a>). If multiple
|
|||
|
|
attributes are specified, only datastores matching all of the attributes
|
|||
|
|
match the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>datastores</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
|
|||
|
|
If None or empty, datastores with any identifier match the filter.</p></li>
|
|||
|
|
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names that datastores must have to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Datastore.Info.name</span></code>).
|
|||
|
|
If None or empty, datastores with any name match the filter.</p></li>
|
|||
|
|
<li><p><strong>types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter_client.Datastore.Type" title="com.vmware.vcenter_client.Datastore.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.Type</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Types that datastores must have to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Datastore.Summary.type</span></code>).
|
|||
|
|
If None or empty, datastores with any type match the filter.</p></li>
|
|||
|
|
<li><p><strong>folders</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Folder</span></code>. When methods return a value of this class as a return
|
|||
|
|
value, the attribute will contain identifiers for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
If None or empty, datastores in any folder match the filter.</p></li>
|
|||
|
|
<li><p><strong>datacenters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.
|
|||
|
|
If None or empty, datastores in any datacenter match the filter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">accessible=None</em>, <em class="sig-param">free_space=None</em>, <em class="sig-param">multiple_host_access=None</em>, <em class="sig-param">thin_provisioning_supported=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datastore.Info</span></code> class contains information about a datastore.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the datastore.</p></li>
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.Type" title="com.vmware.vcenter_client.Datastore.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.Type</span></code></a>) – Type (VMFS, NFS, NFS41, CIFS, VSAN, VFFS, VVOL) of the datastore.</p></li>
|
|||
|
|
<li><p><strong>accessible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether or not this datastore is accessible.</p></li>
|
|||
|
|
<li><p><strong>free_space</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Available space of this datastore, in bytes.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>The server periodically updates this value.</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<p>This attribute will be None if the available space of this
|
|||
|
|
datastore is not known.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>multiple_host_access</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether or not ore than one host in the datacenter has been
|
|||
|
|
configured with access to the datastore.</p></li>
|
|||
|
|
<li><p><strong>thin_provisioning_supported</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether or not the datastore supports thin provisioning on a per
|
|||
|
|
file basis. When thin provisioning is used, backing storage is
|
|||
|
|
lazily allocated.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><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><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">datastore=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">free_space=None</em>, <em class="sig-param">capacity=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datastore.Summary</span></code> class contains commonly used information about a
|
|||
|
|
datastore.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the datastore.</p></li>
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.Type" title="com.vmware.vcenter_client.Datastore.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.Type</span></code></a>) – Type (VMFS, NFS, NFS41, CIFS, VSAN, VFFS, VVOL) of the datatore.</p></li>
|
|||
|
|
<li><p><strong>free_space</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Available space of this datastore, in bytes.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>The server periodically updates this value.</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<p>This attribute will be None if the available space of this
|
|||
|
|
datastore is not known.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Capacity of this datastore, in bytes.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>The server periodically updates this value.</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<p>This attribute will be None if the capacity of this datastore is
|
|||
|
|
not known.</p>
|
|||
|
|
</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datastore.Type</span></code> class defines the supported types of vCenter
|
|||
|
|
datastores.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.CIFS">
|
|||
|
|
<code class="sig-name descname">CIFS</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">NFS</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">NFS41</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">VFFS</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">VMFS</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">VSAN</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">VVOL</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">datastore</em><span class="sig-paren">)</span><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 <code class="docutils literal notranslate"><span class="pre">datastore</span></code>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the datastore for which information should be
|
|||
|
|
retrieved.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.Datastore.Info" title="com.vmware.vcenter_client.Datastore.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>information about the datastore.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the datastore indicated by <code class="docutils literal notranslate"><span class="pre">datastore</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about at most 2500 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.FilterSpec</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="com.vmware.vcenter_client.Datastore.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.FilterSpec</span></code></a> with all attributes None which means
|
|||
|
|
all datastores match the filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.Datastore.list" title="com.vmware.vcenter_client.Datastore.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter_client.Datastore.Summary" title="com.vmware.vcenter_client.Datastore.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Datastore.FilterSpec.types</span></code> attribute contains a
|
|||
|
|
value that is not supported by the server.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Datastore.FilterSpec.types</span></code> attribute contains a
|
|||
|
|
value that is not supported by the server.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if more than 2500 datastores match the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="com.vmware.vcenter_client.Datastore.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Deployment">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter_client.</code><code class="sig-name descname">Deployment</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Deployment" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Deployment</span></code> class provides methods to get the status of the vCenter
|
|||
|
|
appliance deployment. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Deployment.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">state=None</em>, <em class="sig-param">progress=None</em>, <em class="sig-param">subtask_order=None</em>, <em class="sig-param">subtasks=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">operation=None</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">target=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">cancelable=None</em>, <em class="sig-param">error=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Deployment.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Deployment.Info</span></code> class contains attributes to describe the state of
|
|||
|
|
the appliance. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.ApplianceState" title="com.vmware.vcenter.deployment_client.ApplianceState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.ApplianceState</span></code></a>) – State of the vCenter Server Appliance. This attribute was added in
|
|||
|
|
vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) – The progress info of the current appliance status. This attribute
|
|||
|
|
was added in vSphere API 6.7.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>subtask_order</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The ordered list of subtasks for this deployment operation. This
|
|||
|
|
attribute was added in vSphere API 6.7.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> when the appliance state is RUNNING_IN_PROGRESS,
|
|||
|
|
FAILED, CANCELLED and SUCCEEDED.</p></li>
|
|||
|
|
<li><p><strong>subtasks</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter_client.Deployment.Task" title="com.vmware.vcenter_client.Deployment.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Deployment.Task</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The map of the deployment subtasks and their status infomation.
|
|||
|
|
This attribute was added in vSphere API 6.7.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> when the appliance state is RUNNING_IN_PROGRESS,
|
|||
|
|
FAILED, CANCELLED and SUCCEEDED.</p></li>
|
|||
|
|
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
|
|||
|
|
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
|||
|
|
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
|||
|
|
<li><p><strong>parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent of the current task.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
|
|||
|
|
as a return value, the attribute will be an identifier for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
|
|||
|
|
This attribute will be None if the task has no parent.</p></li>
|
|||
|
|
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
|
|||
|
|
one the operation performed on.
|
|||
|
|
This attribute will be None if the operation has no target or
|
|||
|
|
multiple targets.</p></li>
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
|
|||
|
|
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
|
|||
|
|
value may change as the operation progresses.</p></li>
|
|||
|
|
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
|
|||
|
|
If None the description of why the operation failed will be
|
|||
|
|
included in the result of the operation (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</p></li>
|
|||
|
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the user who performed the operation.
|
|||
|
|
This attribute will be None if the operation is performed by the
|
|||
|
|
system.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Deployment.Task">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Task</code><span class="sig-paren">(</span><em class="sig-param">progress=None</em>, <em class="sig-param">result=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">operation=None</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">target=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">cancelable=None</em>, <em class="sig-param">error=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Deployment.Task" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Deployment.Task</span></code> class contains attributes to describe a particular
|
|||
|
|
deployment task. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) – The progress info of this deployment task. This attribute was added
|
|||
|
|
in vSphere API 6.7.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>result</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.Notifications" title="com.vmware.vcenter.deployment_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Result of the task. This attribute was added in vSphere API 6.7.
|
|||
|
|
This attribute will be None if result is not available at the
|
|||
|
|
current step of the task.</p></li>
|
|||
|
|
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
|
|||
|
|
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
|||
|
|
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
|||
|
|
<li><p><strong>parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent of the current task.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
|
|||
|
|
as a return value, the attribute will be an identifier for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
|
|||
|
|
This attribute will be None if the task has no parent.</p></li>
|
|||
|
|
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
|
|||
|
|
one the operation performed on.
|
|||
|
|
This attribute will be None if the operation has no target or
|
|||
|
|
multiple targets.</p></li>
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
|
|||
|
|
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
|
|||
|
|
value may change as the operation progresses.</p></li>
|
|||
|
|
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
|
|||
|
|
If None the description of why the operation failed will be
|
|||
|
|
included in the result of the operation (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</p></li>
|
|||
|
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
|
|||
|
|
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the user who performed the operation.
|
|||
|
|
This attribute will be None if the operation is performed by the
|
|||
|
|
system.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Deployment.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Deployment.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get the current status of the appliance deployment. This method was
|
|||
|
|
added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter_client.Deployment.Info" title="com.vmware.vcenter_client.Deployment.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Deployment.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Info structure containing the status information about the
|
|||
|
|
appliance.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if appliance state cannot be determined.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Deployment.rollback">
|
|||
|
|
<code class="sig-name descname">rollback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Deployment.rollback" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Rollback a failed appliance so it can be configured once again. This
|
|||
|
|
method was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the appliance is not in FAILED state.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the caller is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter_client.</code><code class="sig-name descname">Folder</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Folder" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The Folder class provides methods for manipulating a vCenter Server folder.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">folders=None</em>, <em class="sig-param">names=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">parent_folders=None</em>, <em class="sig-param">datacenters=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Folder.FilterSpec</span></code> 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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Folder.list()</span></code></a>). If multiple
|
|||
|
|
attributes are specified, only folders matching all of the attributes match
|
|||
|
|
the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>folders</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Folder</span></code>. When methods return a value of this class as a return
|
|||
|
|
value, the attribute will contain identifiers for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
If None or empty, folders with any identifier match the filter.</p></li>
|
|||
|
|
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names that folders must have to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Folder.Summary.name</span></code>).
|
|||
|
|
If None or empty, folders with any name match the filter.</p></li>
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Folder.Type" title="com.vmware.vcenter_client.Folder.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Folder.Type</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Type that folders must have to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Folder.Summary.type</span></code>).
|
|||
|
|
If None, folders with any type match the filter.</p></li>
|
|||
|
|
<li><p><strong>parent_folders</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Folder</span></code>. When methods return a value of this class as a return
|
|||
|
|
value, the attribute will contain identifiers for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
If None or empty, folder in any folder match the filter.</p></li>
|
|||
|
|
<li><p><strong>datacenters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.
|
|||
|
|
If None or empty, folder in any datacenter match the filter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><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><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">folder=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Folder.Summary</span></code> class contains commonly used information about a
|
|||
|
|
folder.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the vCenter Server folder.</p></li>
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Folder.Type" title="com.vmware.vcenter_client.Folder.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Folder.Type</span></code></a>) – Type (DATACENTER, DATASTORE, HOST, NETWORK, VIRTUAL_MACHINE) of the
|
|||
|
|
vCenter Server folder.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Folder.Type</span></code> 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="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type.DATACENTER">
|
|||
|
|
<code class="sig-name descname">DATACENTER</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">DATASTORE</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">HOST</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">NETWORK</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">VIRTUAL_MACHINE</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Folder.FilterSpec</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="com.vmware.vcenter_client.Folder.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Folder.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Folder.FilterSpec</span></code></a>
|
|||
|
|
with all attributes None which means all folders match the filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.Folder.list" title="com.vmware.vcenter_client.Folder.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter_client.Folder.Summary" title="com.vmware.vcenter_client.Folder.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Folder.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Folder.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Folder.FilterSpec.type</span></code> attribute contains a value
|
|||
|
|
that is not supported by the server.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if more than 1000 folders match the <a class="reference internal" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="com.vmware.vcenter_client.Folder.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Folder.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter_client.</code><code class="sig-name descname">Host</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Host</span></code> class provides methods to manage hosts in the vCenter Server.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.ConnectionState">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ConnectionState</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.ConnectionState" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Host.ConnectionState</span></code> class defines the connection status of a host.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectionState</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.ConnectionState.CONNECTED">
|
|||
|
|
<code class="sig-name descname">CONNECTED</code><em class="property"> = ConnectionState(string='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">
|
|||
|
|
<code class="sig-name descname">DISCONNECTED</code><em class="property"> = ConnectionState(string='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">
|
|||
|
|
<code class="sig-name descname">NOT_RESPONDING</code><em class="property"> = ConnectionState(string='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><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">hostname=None</em>, <em class="sig-param">port=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">password=None</em>, <em class="sig-param">folder=None</em>, <em class="sig-param">thumbprint_verification=None</em>, <em class="sig-param">thumbprint=None</em>, <em class="sig-param">force_add=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Host.CreateSpec</span></code> class defines the information used to create a
|
|||
|
|
host.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IP address or DNS resolvable name of the host.</p></li>
|
|||
|
|
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The port of the host.
|
|||
|
|
If None, port 443 will be used.</p></li>
|
|||
|
|
<li><p><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The administrator account on the host.</p></li>
|
|||
|
|
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The password for the administrator account on the host.</p></li>
|
|||
|
|
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
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.</p></li>
|
|||
|
|
<li><p><strong>thumbprint_verification</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification" title="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.CreateSpec.ThumbprintVerification</span></code></a>) – Type of host’s SSL certificate verification to be done.</p></li>
|
|||
|
|
<li><p><strong>thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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 <code class="docutils literal notranslate"><span class="pre">thumbprintVerification</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.THUMBPRINT" title="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.THUMBPRINT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Host.CreateSpec.ThumbprintVerification.THUMBPRINT</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>force_add</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ThumbprintVerification</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Host.CreateSpec.ThumbprintVerification</span></code> class defines the thumbprint
|
|||
|
|
verification schemes for a host’s SSL certificate.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ThumbprintVerification</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.NONE">
|
|||
|
|
<code class="sig-name descname">NONE</code><em class="property"> = ThumbprintVerification(string='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">
|
|||
|
|
<code class="sig-name descname">THUMBPRINT</code><em class="property"> = ThumbprintVerification(string='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><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">hosts=None</em>, <em class="sig-param">names=None</em>, <em class="sig-param">folders=None</em>, <em class="sig-param">datacenters=None</em>, <em class="sig-param">standalone=None</em>, <em class="sig-param">clusters=None</em>, <em class="sig-param">connection_states=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Host.FilterSpec</span></code> 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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Host.list()</span></code></a>). If multiple attributes
|
|||
|
|
are specified, only hosts matching all of the attributes match the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
|
|||
|
|
If None or empty, hosts with any identifier match the filter.</p></li>
|
|||
|
|
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names that hosts must have to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Host.Summary.name</span></code>).
|
|||
|
|
If None or empty, hosts with any name match the filter.</p></li>
|
|||
|
|
<li><p><strong>folders</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Folder</span></code>. When methods return a value of this class as a return
|
|||
|
|
value, the attribute will contain identifiers for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
If None or empty, hosts in any folder match the filter.</p></li>
|
|||
|
|
<li><p><strong>datacenters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.
|
|||
|
|
If None or empty, hosts in any datacenter match the filter.</p></li>
|
|||
|
|
<li><p><strong>standalone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Host.FilterSpec.clusters</span></code> os not empty, no hosts will match
|
|||
|
|
the filter.</p></li>
|
|||
|
|
<li><p><strong>clusters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will contain identifiers for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
|||
|
|
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
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Host.FilterSpec.standalone</span></code> is true, no hosts will match the
|
|||
|
|
filter.</p></li>
|
|||
|
|
<li><p><strong>connection_states</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter_client.Host.ConnectionState" title="com.vmware.vcenter_client.Host.ConnectionState"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.ConnectionState</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Connection states that a host must be in to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Host.Summary.connection_state</span></code>.
|
|||
|
|
If None or empty, hosts in any connection state match the filter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.PowerState">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">PowerState</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.PowerState" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Host.PowerState</span></code> class defines the power states of a host.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">PowerState</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.PowerState.POWERED_OFF">
|
|||
|
|
<code class="sig-name descname">POWERED_OFF</code><em class="property"> = PowerState(string='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">
|
|||
|
|
<code class="sig-name descname">POWERED_ON</code><em class="property"> = PowerState(string='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">
|
|||
|
|
<code class="sig-name descname">STANDBY</code><em class="property"> = PowerState(string='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">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><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><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">host=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">connection_state=None</em>, <em class="sig-param">power_state=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Host.Summary</span></code> class contains commonly used information about a host
|
|||
|
|
in vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the host.</p></li>
|
|||
|
|
<li><p><strong>connection_state</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Host.ConnectionState" title="com.vmware.vcenter_client.Host.ConnectionState"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.ConnectionState</span></code></a>) – Connection status of the host</p></li>
|
|||
|
|
<li><p><strong>power_state</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Host.PowerState" title="com.vmware.vcenter_client.Host.PowerState"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.PowerState</span></code></a>) – Power state of the host
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">connectionState</span></code> is <a class="reference internal" href="#com.vmware.vcenter_client.Host.ConnectionState.CONNECTED" title="com.vmware.vcenter_client.Host.ConnectionState.CONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Host.ConnectionState.CONNECTED</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.connect">
|
|||
|
|
<code class="sig-name descname">connect</code><span class="sig-paren">(</span><em class="sig-param">host</em><span class="sig-paren">)</span><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 <code class="docutils literal notranslate"><span class="pre">host</span></code> previously added to the
|
|||
|
|
vCenter server.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the host to be reconnected.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> is already connected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if there is no host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> in the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.CreateSpec.ThumbprintVerification</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Host.CreateSpec" title="com.vmware.vcenter_client.Host.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.CreateSpec</span></code></a>) – Specification for the new host to be created.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>The newly created identifier of the host in vCenter.
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
if the host with the same name is already present.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if installation of VirtualCenter agent on a host fails.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the host name is invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the host folder is invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the SSL thumbprint specified is invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code></a>
|
|||
|
|
if the host folder id does not support vSphere compute resource as
|
|||
|
|
its children type.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if there is no folder associated with the <code class="docutils literal notranslate"><span class="pre">folder</span></code> attribute in
|
|||
|
|
the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
|
|||
|
|
if the host is already being managed by another vCenter Server</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if there are not enough licenses to add the host.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user name or password for the administration account on the
|
|||
|
|
host are invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the software version on the host is not supported.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">host</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the host to be deleted.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if there is no host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> in the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
|
|||
|
|
if the host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> is in a vCenter cluster</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.disconnect">
|
|||
|
|
<code class="sig-name descname">disconnect</code><span class="sig-paren">(</span><em class="sig-param">host</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.disconnect" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Disconnect the host corresponding to <code class="docutils literal notranslate"><span class="pre">host</span></code> from the vCenter server</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the host to be disconnected.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> is already disconnected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if there is no host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> in the system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about at most 2500 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.FilterSpec</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Host.FilterSpec" title="com.vmware.vcenter_client.Host.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.FilterSpec</span></code></a>
|
|||
|
|
with all attributes None which means all hosts match the filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.Host.list" title="com.vmware.vcenter_client.Host.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter_client.Host.Summary" title="com.vmware.vcenter_client.Host.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Host.FilterSpec.connection_states</span></code> attribute contains
|
|||
|
|
a value that is not supported by the server.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if more than 2500 hosts match the <a class="reference internal" href="#com.vmware.vcenter_client.Host.FilterSpec" title="com.vmware.vcenter_client.Host.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter_client.</code><code class="sig-name descname">Network</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Network" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The Network class provides methods for manipulating a vCenter Server
|
|||
|
|
network.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">networks=None</em>, <em class="sig-param">names=None</em>, <em class="sig-param">types=None</em>, <em class="sig-param">folders=None</em>, <em class="sig-param">datacenters=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Network.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Network.FilterSpec</span></code> 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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Network.list()</span></code></a>). If multiple
|
|||
|
|
attributes are specified, only networks matching all of the attributes
|
|||
|
|
match the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Network</span></code>. When methods return a value of this class as a return
|
|||
|
|
value, the attribute will contain identifiers for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
|
|||
|
|
If None or empty, networks with any identifier match the filter.</p></li>
|
|||
|
|
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names that networks must have to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.Summary.name</span></code>).
|
|||
|
|
If None or empty, networks with any name match the filter.</p></li>
|
|||
|
|
<li><p><strong>types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter_client.Network.Type" title="com.vmware.vcenter_client.Network.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.Type</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Types that networks must have to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.Summary.type</span></code>).
|
|||
|
|
If None, networks with any type match the filter.</p></li>
|
|||
|
|
<li><p><strong>folders</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Folder</span></code>. When methods return a value of this class as a return
|
|||
|
|
value, the attribute will contain identifiers for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
If None or empty, networks in any folder match the filter.</p></li>
|
|||
|
|
<li><p><strong>datacenters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.
|
|||
|
|
If None or empty, networks in any datacenter match the filter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><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><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">network=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Network.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Network.Summary</span></code> class contains commonly used information about a
|
|||
|
|
network.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the network.</p></li>
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Network.Type" title="com.vmware.vcenter_client.Network.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.Type</span></code></a>) – Type (STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP, OPAQUE_NETWORK) of
|
|||
|
|
the vCenter Server network.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network.Type">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Network.Type" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Network.Type</span></code> 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="admonition-title">Note</p>
|
|||
|
|
<p>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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network.Type.DISTRIBUTED_PORTGROUP">
|
|||
|
|
<code class="sig-name descname">DISTRIBUTED_PORTGROUP</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">OPAQUE_NETWORK</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">STANDARD_PORTGROUP</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.FilterSpec</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Network.FilterSpec" title="com.vmware.vcenter_client.Network.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.FilterSpec</span></code></a> with all attributes None which means
|
|||
|
|
all networks match the filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.Network.list" title="com.vmware.vcenter_client.Network.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter_client.Network.Summary" title="com.vmware.vcenter_client.Network.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Network.FilterSpec.types</span></code> attribute contains a value
|
|||
|
|
that is not supported by the server.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if more than 1000 networks match the <a class="reference internal" href="#com.vmware.vcenter_client.Network.FilterSpec" title="com.vmware.vcenter_client.Network.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter_client.</code><code class="sig-name descname">ResourcePool</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The 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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">resource_pools=None</em>, <em class="sig-param">names=None</em>, <em class="sig-param">parent_resource_pools=None</em>, <em class="sig-param">datacenters=None</em>, <em class="sig-param">hosts=None</em>, <em class="sig-param">clusters=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ResourcePool.FilterSpec</span></code> 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"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResourcePool.list()</span></code></a>). If
|
|||
|
|
multiple attributes are specified, only resource pools matching all of the
|
|||
|
|
attributes match the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>resource_pools</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.
|
|||
|
|
If None or empty, resource pools with any identifier match the
|
|||
|
|
filter.</p></li>
|
|||
|
|
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names that resource pools must have to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourcePool.Info.name</span></code>).
|
|||
|
|
If None or empty, resource pools with any name match the filter.</p></li>
|
|||
|
|
<li><p><strong>parent_resource_pools</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.
|
|||
|
|
If None or empty, resource pools in any resource pool match the
|
|||
|
|
filter.</p></li>
|
|||
|
|
<li><p><strong>datacenters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.
|
|||
|
|
If None or empty, resource pools in any datacenter match the
|
|||
|
|
filter.</p></li>
|
|||
|
|
<li><p><strong>hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
|
|||
|
|
If None or empty, resource pools in any host match the filter.</p></li>
|
|||
|
|
<li><p><strong>clusters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will contain identifiers for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
|||
|
|
If None or empty, resource pools in any cluster match the filter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">resource_pools=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ResourcePool.Info</span></code> class contains information about a resource pool.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the vCenter Server resource pool.</p></li>
|
|||
|
|
<li><p><strong>resource_pools</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><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><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">resource_pool=None</em>, <em class="sig-param">name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ResourcePool.Summary</span></code> class contains commonly used information about
|
|||
|
|
a resource pool in vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the resource pool.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">resource_pool</em><span class="sig-paren">)</span><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
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">resource_pool</span></code>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the resource pool for which information should be
|
|||
|
|
retrieved.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.Info" title="com.vmware.vcenter_client.ResourcePool.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the resource pool.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If the resource pool indicated by <code class="docutils literal notranslate"><span class="pre">resource_pool</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
If the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
If the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">resource_pool</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.FilterSpec</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.FilterSpec" title="com.vmware.vcenter_client.ResourcePool.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.FilterSpec</span></code></a> with all attributes None which
|
|||
|
|
means all resource pools match the filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.list" title="com.vmware.vcenter_client.ResourcePool.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.Summary" title="com.vmware.vcenter_client.ResourcePool.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
If 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
If the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
If the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
If the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter_client.</code><code class="sig-name descname">VM</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM</span></code> class provides methods for managing the lifecycle of a virtual
|
|||
|
|
machine.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.ComputePlacementSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ComputePlacementSpec</code><span class="sig-paren">(</span><em class="sig-param">resource_pool=None</em>, <em class="sig-param">host=None</em>, <em class="sig-param">cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.ComputePlacementSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.ComputePlacementSpec</span></code> class contains information used to place a
|
|||
|
|
virtual machine on compute resources.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource pool into which the virtual machine should be placed.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.
|
|||
|
|
This attribute is currently required if both <code class="docutils literal notranslate"><span class="pre">host</span></code> and
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">cluster</span></code> 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.</p></li>
|
|||
|
|
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Host onto which the virtual machine should be placed.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified,
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must belong to <code class="docutils literal notranslate"><span class="pre">host</span></code>.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">cluster</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a
|
|||
|
|
member of <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
|
|||
|
|
This attribute may be None if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">cluster</span></code> is
|
|||
|
|
specified. If None, the system will attempt to choose a suitable
|
|||
|
|
host for the virtual machine; if a host cannot be chosen, the
|
|||
|
|
virtual machine creation operation will fail.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Cluster into which the virtual machine should be placed.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified,
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must belong to <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and <code class="docutils literal notranslate"><span class="pre">host</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a
|
|||
|
|
member of <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
|||
|
|
If <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">host</span></code> is specified, it is recommended
|
|||
|
|
that this attribute be None.</p>
|
|||
|
|
</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">guest_os=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">placement=None</em>, <em class="sig-param">hardware_version=None</em>, <em class="sig-param">boot=None</em>, <em class="sig-param">boot_devices=None</em>, <em class="sig-param">cpu=None</em>, <em class="sig-param">memory=None</em>, <em class="sig-param">disks=None</em>, <em class="sig-param">nics=None</em>, <em class="sig-param">cdroms=None</em>, <em class="sig-param">floppies=None</em>, <em class="sig-param">parallel_ports=None</em>, <em class="sig-param">serial_ports=None</em>, <em class="sig-param">sata_adapters=None</em>, <em class="sig-param">scsi_adapters=None</em>, <em class="sig-param">storage_policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Document-based creation spec.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.GuestOS</span></code></a>) – Guest OS.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual machine name.
|
|||
|
|
If None, a default name will be generated by the server.</p></li>
|
|||
|
|
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.PlacementSpec" title="com.vmware.vcenter_client.VM.PlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.PlacementSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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.</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.Hardware.Version</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual hardware version.
|
|||
|
|
If None, defaults to the most recent version supported by the
|
|||
|
|
server.</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Boot.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Boot configuration.
|
|||
|
|
If None, guest-specific default values will be used.</p></li>
|
|||
|
|
<li><p><strong>boot_devices</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.boot_client.Device.EntryCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Boot device configuration.
|
|||
|
|
If None, a server-specific boot sequence will be used.</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – CPU configuration.
|
|||
|
|
If None, guest-specific default values will be used.</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Memory configuration.
|
|||
|
|
If None, guest-specific default values will be used.</p></li>
|
|||
|
|
<li><p><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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.</p></li>
|
|||
|
|
<li><p><strong>nics</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of Ethernet adapters.
|
|||
|
|
If None, no Ethernet adapters will be created.</p></li>
|
|||
|
|
<li><p><strong>cdroms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of CD-ROMs.
|
|||
|
|
If None, no CD-ROM devices will be created.</p></li>
|
|||
|
|
<li><p><strong>floppies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of floppy drives.
|
|||
|
|
If None, no floppy drives will be created.</p></li>
|
|||
|
|
<li><p><strong>parallel_ports</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of parallel ports.
|
|||
|
|
If None, no parallel ports will be created.</p></li>
|
|||
|
|
<li><p><strong>serial_ports</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of serial ports.
|
|||
|
|
If None, no serial ports will be created.</p></li>
|
|||
|
|
<li><p><strong>sata_adapters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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.</p></li>
|
|||
|
|
<li><p><strong>scsi_adapters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client.Scsi.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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.</p></li>
|
|||
|
|
<li><p><strong>storage_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.StoragePolicySpec" title="com.vmware.vcenter_client.VM.StoragePolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.StoragePolicySpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The <code class="docutils literal notranslate"><span class="pre">VM.StoragePolicySpec</span></code> class contains information about the
|
|||
|
|
storage policy that is to be associated with the virtual machine
|
|||
|
|
home (which contains the configuration and log files). This
|
|||
|
|
attribute was added in vSphere API 6.7.
|
|||
|
|
If None the datastore default storage policy (if applicable) is
|
|||
|
|
applied. Currently a default storage policy is only supported by
|
|||
|
|
object datastores : VVol and vSAN. For non-object datastores, if
|
|||
|
|
None then no storage policy would be associated with the virtual
|
|||
|
|
machine home.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">vms=None</em>, <em class="sig-param">names=None</em>, <em class="sig-param">folders=None</em>, <em class="sig-param">datacenters=None</em>, <em class="sig-param">hosts=None</em>, <em class="sig-param">clusters=None</em>, <em class="sig-param">resource_pools=None</em>, <em class="sig-param">power_states=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code> 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"><code class="xref py py-func docutils literal notranslate"><span class="pre">VM.list()</span></code></a>). If multiple attributes
|
|||
|
|
are specified, only virtual machines matching all of the attributes match
|
|||
|
|
the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.
|
|||
|
|
If None or empty, virtual machines with any identifier match the
|
|||
|
|
filter.</p></li>
|
|||
|
|
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names that virtual machines must have to match the filter (see
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.Info.name</span></code>).
|
|||
|
|
If None or empty, virtual machines with any name match the filter.</p></li>
|
|||
|
|
<li><p><strong>folders</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Folder</span></code>. When methods return a value of this class as a return
|
|||
|
|
value, the attribute will contain identifiers for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
If None or empty, virtual machines in any folder match the filter.</p></li>
|
|||
|
|
<li><p><strong>datacenters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.
|
|||
|
|
If None or empty, virtual machines in any datacenter match the
|
|||
|
|
filter.</p></li>
|
|||
|
|
<li><p><strong>hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
|
|||
|
|
If None or empty, virtual machines on any host match the filter.</p></li>
|
|||
|
|
<li><p><strong>clusters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will contain identifiers for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
|||
|
|
If None or empty, virtual machines in any cluster match the filter.</p></li>
|
|||
|
|
<li><p><strong>resource_pools</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will contain identifiers for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.
|
|||
|
|
If None or empty, virtual machines in any resource pool match the
|
|||
|
|
filter.</p></li>
|
|||
|
|
<li><p><strong>power_states</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.Power.State</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Power states that a virtual machine must be in to match the filter
|
|||
|
|
(see <code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.Power.Info.state</span></code>.
|
|||
|
|
If None or empty, virtual machines in any power state match the
|
|||
|
|
filter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">guest_os=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">identity=None</em>, <em class="sig-param">power_state=None</em>, <em class="sig-param">instant_clone_frozen=None</em>, <em class="sig-param">hardware=None</em>, <em class="sig-param">boot=None</em>, <em class="sig-param">boot_devices=None</em>, <em class="sig-param">cpu=None</em>, <em class="sig-param">memory=None</em>, <em class="sig-param">disks=None</em>, <em class="sig-param">nics=None</em>, <em class="sig-param">cdroms=None</em>, <em class="sig-param">floppies=None</em>, <em class="sig-param">parallel_ports=None</em>, <em class="sig-param">serial_ports=None</em>, <em class="sig-param">sata_adapters=None</em>, <em class="sig-param">scsi_adapters=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Document-based info.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.GuestOS</span></code></a>) – Guest OS.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine name.</p></li>
|
|||
|
|
<li><p><strong>identity</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.Identity.Info" title="com.vmware.vcenter.vm_client.Identity.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.Identity.Info</span></code></a>) – Identity of the virtual machine. This attribute was added in
|
|||
|
|
vSphere API 6.7.1.
|
|||
|
|
This attribute is optional because it was added in a newer version
|
|||
|
|
than its parent node.</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.Power.State</span></code></a>) – Power state of the virtual machine.</p></li>
|
|||
|
|
<li><p><strong>instant_clone_frozen</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Indicates whether the virtual machine is frozen for instant clone,
|
|||
|
|
or not. This attribute was added in vSphere API 6.7.1.
|
|||
|
|
This attribute is optional because it was added in a newer version
|
|||
|
|
than its parent node.</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.Hardware.Info</span></code></a>) – Virtual hardware version information.</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Boot.Info</span></code></a>) – Boot configuration.</p></li>
|
|||
|
|
<li><p><strong>boot_devices</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.boot_client.Device.Entry</span></code></a>) – Boot device configuration. If the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> has no entries, a
|
|||
|
|
server-specific default boot sequence is used.</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Cpu.Info</span></code></a>) – CPU configuration.</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Memory.Info</span></code></a>) – Memory configuration.</p></li>
|
|||
|
|
<li><p><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Disk.Info</span></code></a>) – List of disks.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
|
|||
|
|
a value of this class as a return value, the key in the attribute
|
|||
|
|
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</p></li>
|
|||
|
|
<li><p><strong>nics</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Ethernet.Info</span></code></a>) – List of Ethernet adapters.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the key in the
|
|||
|
|
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.</p></li>
|
|||
|
|
<li><p><strong>cdroms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Cdrom.Info</span></code></a>) – List of CD-ROMs.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>. When methods return
|
|||
|
|
a value of this class as a return value, the key in the attribute
|
|||
|
|
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>.</p></li>
|
|||
|
|
<li><p><strong>floppies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Floppy.Info</span></code></a>) – List of floppy drives.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the key in the
|
|||
|
|
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></code>.</p></li>
|
|||
|
|
<li><p><strong>parallel_ports</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Parallel.Info</span></code></a>) – List of parallel ports.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the key in the
|
|||
|
|
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></code>.</p></li>
|
|||
|
|
<li><p><strong>serial_ports</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Serial.Info</span></code></a>) – List of serial ports.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the key in the
|
|||
|
|
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>.</p></li>
|
|||
|
|
<li><p><strong>sata_adapters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client.Sata.Info</span></code></a>) – List of SATA adapters.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SataAdapter</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the key in the
|
|||
|
|
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SataAdapter</span></code>.</p></li>
|
|||
|
|
<li><p><strong>scsi_adapters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Info</span></code></a>) – List of SCSI adapters.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ScsiAdapter</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the key in the
|
|||
|
|
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ScsiAdapter</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.InstantClonePlacementSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">InstantClonePlacementSpec</code><span class="sig-paren">(</span><em class="sig-param">folder=None</em>, <em class="sig-param">resource_pool=None</em>, <em class="sig-param">datastore=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.InstantClonePlacementSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.InstantClonePlacementSpec</span></code> class contains information used to
|
|||
|
|
place an InstantClone of a virtual machine onto resources within the
|
|||
|
|
vCenter inventory. This class was added in vSphere API 6.7.1.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual machine folder into which the InstantCloned virtual machine
|
|||
|
|
should be placed. This attribute was added in vSphere API 6.7.1.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
If attribute is None, the system will use the virtual machine
|
|||
|
|
folder of the source virtual machine.</p></li>
|
|||
|
|
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource pool into which the InstantCloned virtual machine should
|
|||
|
|
be placed. This attribute was added in vSphere API 6.7.1.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.
|
|||
|
|
If attribute is None, the system will use the resource pool of the
|
|||
|
|
source virtual machine.</p></li>
|
|||
|
|
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Datastore on which the InstantCloned 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 InstantClone operation. This attribute was added in vSphere
|
|||
|
|
API 6.7.1.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
|
|||
|
|
If attribute is None, the system will use the datastore of the
|
|||
|
|
source virtual machine.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.InstantCloneSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">InstantCloneSpec</code><span class="sig-paren">(</span><em class="sig-param">source=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">placement=None</em>, <em class="sig-param">nics_to_update=None</em>, <em class="sig-param">disconnect_all_nics=None</em>, <em class="sig-param">parallel_ports_to_update=None</em>, <em class="sig-param">serial_ports_to_update=None</em>, <em class="sig-param">bios_uuid=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.InstantCloneSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Document-based InstantClone spec. This class was added in vSphere API
|
|||
|
|
6.7.1.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine to InstantClone from. This attribute was added in
|
|||
|
|
vSphere API 6.7.1.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the new virtual machine. This attribute was added in
|
|||
|
|
vSphere API 6.7.1.</p></li>
|
|||
|
|
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.InstantClonePlacementSpec" title="com.vmware.vcenter_client.VM.InstantClonePlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.InstantClonePlacementSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual machine placement information. This attribute was added in
|
|||
|
|
vSphere API 6.7.1.
|
|||
|
|
If this attribute is None, the system will use the values from the
|
|||
|
|
source virtual machine. If specified, each field will be used for
|
|||
|
|
placement. If the fields result in disjoint placement the operation
|
|||
|
|
will fail. If the fields along with the placement values of the
|
|||
|
|
source virtual machine result in disjoint placement the operation
|
|||
|
|
will fail.</p></li>
|
|||
|
|
<li><p><strong>nics_to_update</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Map of NICs to update. This attribute was added in vSphere API
|
|||
|
|
6.7.1.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the key in the
|
|||
|
|
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.
|
|||
|
|
If None, no NICs will be updated.</p></li>
|
|||
|
|
<li><p><strong>disconnect_all_nics</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Indicates whether all NICs on the destination virtual machine
|
|||
|
|
should be disconnected from the newtwork. This attribute was added
|
|||
|
|
in vSphere API 6.7.1.
|
|||
|
|
If None, connection status of all NICs on the destination virtual
|
|||
|
|
machine will be the same as on the source virtual machine.</p></li>
|
|||
|
|
<li><p><strong>parallel_ports_to_update</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Map of parallel ports to Update. This attribute was added in
|
|||
|
|
vSphere API 6.7.1.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the key in the
|
|||
|
|
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></code>.
|
|||
|
|
If None, no parallel ports will be updated.</p></li>
|
|||
|
|
<li><p><strong>serial_ports_to_update</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Map of serial ports to Update. This attribute was added in vSphere
|
|||
|
|
API 6.7.1.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the key in the
|
|||
|
|
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>.
|
|||
|
|
If None, no serial ports will be updated.</p></li>
|
|||
|
|
<li><p><strong>bios_uuid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 128-bit SMBIOS UUID of a virtual machine represented as a
|
|||
|
|
hexadecimal string in “12345678-abcd-1234-cdef-123456789abc”
|
|||
|
|
format. This attribute was added in vSphere API 6.7.1.
|
|||
|
|
If None, will be generated.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.InventoryPlacementSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">InventoryPlacementSpec</code><span class="sig-paren">(</span><em class="sig-param">folder=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.InventoryPlacementSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.InventoryPlacementSpec</span></code> class contains information used to place
|
|||
|
|
a virtual machine in the vCenter inventory.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual machine folder into which the virtual machine should be
|
|||
|
|
placed.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
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.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.PlacementSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">PlacementSpec</code><span class="sig-paren">(</span><em class="sig-param">folder=None</em>, <em class="sig-param">resource_pool=None</em>, <em class="sig-param">host=None</em>, <em class="sig-param">cluster=None</em>, <em class="sig-param">datastore=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.PlacementSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.PlacementSpec</span></code> class contains information used to place a virtual
|
|||
|
|
machine onto resources within the vCenter inventory.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual machine folder into which the virtual machine should be
|
|||
|
|
placed.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
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.</p></li>
|
|||
|
|
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource pool into which the virtual machine should be placed.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.
|
|||
|
|
This attribute is currently required if both <code class="docutils literal notranslate"><span class="pre">host</span></code> and
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">cluster</span></code> 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.</p></li>
|
|||
|
|
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Host onto which the virtual machine should be placed.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified,
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must belong to <code class="docutils literal notranslate"><span class="pre">host</span></code>.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">cluster</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a
|
|||
|
|
member of <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
|
|||
|
|
This attribute may be None if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">cluster</span></code> is
|
|||
|
|
specified. If None, the system will attempt to choose a suitable
|
|||
|
|
host for the virtual machine; if a host cannot be chosen, the
|
|||
|
|
virtual machine creation operation will fail.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Cluster into which the virtual machine should be placed.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified,
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must belong to <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and <code class="docutils literal notranslate"><span class="pre">host</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a
|
|||
|
|
member of <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
|||
|
|
If <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">host</span></code> is specified, it is recommended
|
|||
|
|
that this attribute be None.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
|
|||
|
|
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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'VirtualMachine'</em><a class="headerlink" href="#com.vmware.vcenter_client.VM.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Resource type for virtual machines.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.RegisterPlacementSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">RegisterPlacementSpec</code><span class="sig-paren">(</span><em class="sig-param">folder=None</em>, <em class="sig-param">resource_pool=None</em>, <em class="sig-param">host=None</em>, <em class="sig-param">cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.RegisterPlacementSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.RegisterPlacementSpec</span></code> class contains information used to place a
|
|||
|
|
virtual machine, created from existing virtual machine files on storage,
|
|||
|
|
onto resources within the vCenter inventory. This class was added in
|
|||
|
|
vSphere API 6.8.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual machine folder into which the virtual machine should be
|
|||
|
|
placed.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
|
|||
|
|
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.</p></li>
|
|||
|
|
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource pool into which the virtual machine should be placed.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.
|
|||
|
|
This attribute is currently required if both <code class="docutils literal notranslate"><span class="pre">host</span></code> and
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">cluster</span></code> 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.</p></li>
|
|||
|
|
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Host onto which the virtual machine should be placed.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified,
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must belong to <code class="docutils literal notranslate"><span class="pre">host</span></code>.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">cluster</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a
|
|||
|
|
member of <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
|
|||
|
|
This attribute may be None if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">cluster</span></code> is
|
|||
|
|
specified. If None, the system will attempt to choose a suitable
|
|||
|
|
host for the virtual machine; if a host cannot be chosen, the
|
|||
|
|
virtual machine creation operation will fail.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Cluster into which the virtual machine should be placed.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified,
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must belong to <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and <code class="docutils literal notranslate"><span class="pre">host</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a
|
|||
|
|
member of <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
|||
|
|
If <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">host</span></code> is specified, it is recommended
|
|||
|
|
that this attribute be None.</p>
|
|||
|
|
</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.RegisterSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">RegisterSpec</code><span class="sig-paren">(</span><em class="sig-param">datastore=None</em>, <em class="sig-param">path=None</em>, <em class="sig-param">datastore_path=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.RegisterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.RegisterSpec</span></code> class contains information used to create a virtual
|
|||
|
|
machine from existing virtual machine files on storage.</p>
|
|||
|
|
<p>The location of the virtual machine files on storage must be specified by
|
|||
|
|
providing either <code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.datastore</span></code> and
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.path</span></code> or by providing
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.datastore_path</span></code>. If
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.datastore</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.path</span></code> are
|
|||
|
|
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.datastore_path</span></code> must be None, and if
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.datastore_path</span></code> is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>,
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.datastore</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.path</span></code> must be
|
|||
|
|
None.. This class was added in vSphere API 6.8.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the datastore on which the virtual machine’s
|
|||
|
|
configuration state is stored. This attribute was added in vSphere
|
|||
|
|
API 6.8.7.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
|
|||
|
|
If None, <code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.path</span></code> must also be None and
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.datastore_path</span></code> must be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.</p></li>
|
|||
|
|
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Path to the virtual machine’s configuration file on the datastore
|
|||
|
|
corresponding to {\@link #datastore). This attribute was added
|
|||
|
|
in vSphere API 6.8.7.
|
|||
|
|
If None, <code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.datastore</span></code> must also be None and
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.datastore_path</span></code> must be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.</p></li>
|
|||
|
|
<li><p><strong>datastore_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Datastore path for the virtual machine’s configuration file in the
|
|||
|
|
format “[datastore name] path”. For example “[storage1]
|
|||
|
|
Test-VM/Test-VM.vmx”. This attribute was added in vSphere API
|
|||
|
|
6.8.7.
|
|||
|
|
If None, both <code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.datastore</span></code> and
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.path</span></code> must be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual machine name. This attribute was added in vSphere API
|
|||
|
|
6.8.7.
|
|||
|
|
If None, the display name from the virtual machine’s configuration
|
|||
|
|
file will be used.</p></li>
|
|||
|
|
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.RegisterPlacementSpec" title="com.vmware.vcenter_client.VM.RegisterPlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.RegisterPlacementSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual machine placement information. This attribute was added in
|
|||
|
|
vSphere API 6.8.7.
|
|||
|
|
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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.StoragePlacementSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">StoragePlacementSpec</code><span class="sig-paren">(</span><em class="sig-param">datastore=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.StoragePlacementSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.StoragePlacementSpec</span></code> class contains information used to store a
|
|||
|
|
virtual machine’s files.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
|
|||
|
|
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.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.StoragePolicySpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">StoragePolicySpec</code><span class="sig-paren">(</span><em class="sig-param">policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.StoragePolicySpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.StoragePolicySpec</span></code> class contains information about the storage
|
|||
|
|
policy to be associated with a virtual machine object. This class was added
|
|||
|
|
in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the storage policy which should be associated with
|
|||
|
|
the virtual machine. This attribute was added in vSphere API 6.7.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
|
|||
|
|
of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">vm=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">power_state=None</em>, <em class="sig-param">cpu_count=None</em>, <em class="sig-param">memory_size_mib=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.Summary</span></code> class contains commonly used information about a virtual
|
|||
|
|
machine.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the Virtual machine.</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.Power.State</span></code></a>) – Power state of the virtual machine.</p></li>
|
|||
|
|
<li><p><strong>cpu_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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.</p></li>
|
|||
|
|
<li><p><strong>memory_size_mib</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Creates a virtual machine.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.CreateSpec" title="com.vmware.vcenter_client.VM.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.CreateSpec</span></code></a>) – Virtual machine specification.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>ID of newly-created virtual machine.
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
if a virtual machine with the specified name already exists.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if any of the specified parameters are invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if any of the resources specified in spec could not be found</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if a specified resource (eg. host) is not accessible.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
|
|||
|
|
if any of the specified storage addresses (eg. IDE, SATA, SCSI)
|
|||
|
|
result in a storage address conflict.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if any of the resources needed to create the virtual machine could
|
|||
|
|
not be allocated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">guestOS</span></code> is not supported for the requested virtual hardware
|
|||
|
|
version and spec includes None attributes that default to
|
|||
|
|
guest-specific values.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Folder</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.InventoryPlacementSpec.folder</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Inventory.Create</span></code>.</p></li>
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.ComputePlacementSpec.resource_pool</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Resource.AssignVMToPool</span></code>.</p></li>
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.StoragePlacementSpec.datastore</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datastore.AllocateSpace</span></code>.</p></li>
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Network</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec.network</span></code>
|
|||
|
|
requires <code class="docutils literal notranslate"><span class="pre">Network.Assign</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Deletes a virtual machine.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is running (powered on).</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.Inventory.Delete</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.VM.Info" title="com.vmware.vcenter_client.VM.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the specified virtual machine.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.instant_clone">
|
|||
|
|
<code class="sig-name descname">instant_clone</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.instant_clone" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Create an instant clone of an existing virtual machine. This method was
|
|||
|
|
added in vSphere API 6.7.1.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.InstantCloneSpec" title="com.vmware.vcenter_client.VM.InstantCloneSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.InstantCloneSpec</span></code></a>) – Virtual machine InstantCloneSpec.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>ID of newly-created virtual machine.
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
if a virtual machine with the specified name already exists.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if any of the specified parameters are invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if any of the resources specified in spec could not be found</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if a specified resource (eg. host) is not accessible.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if any of the resources needed to create an instant clone could not
|
|||
|
|
be allocated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.InstantCloneSpec.source</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Provisioning.Clone</span></code> and
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Inventory.CreateFromExisting</span></code>.</p></li>
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Folder</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.InstantClonePlacementSpec.folder</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Interact.PowerOn</span></code>.</p></li>
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.InstantClonePlacementSpec.resource_pool</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Resource.AssignVMToPool</span></code>.</p></li>
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.InstantClonePlacementSpec.datastore</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datastore.AllocateSpace</span></code>.</p></li>
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Network</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec.network</span></code>
|
|||
|
|
requires <code class="docutils literal notranslate"><span class="pre">Network.Assign</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about at most 4000 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a>.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.FilterSpec" title="com.vmware.vcenter_client.VM.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a>
|
|||
|
|
with all attributes None which means all virtual machines match the
|
|||
|
|
filter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter_client.VM.list" title="com.vmware.vcenter_client.VM.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter_client.VM.Summary" title="com.vmware.vcenter_client.VM.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.FilterSpec.power_states</span></code> attribute contains a
|
|||
|
|
value that is not supported by the server.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if more than 4000 virtual machines match the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.VM.FilterSpec" title="com.vmware.vcenter_client.VM.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.register">
|
|||
|
|
<code class="sig-name descname">register</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.register" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Creates a virtual machine from existing virtual machine files on
|
|||
|
|
storage. This method was added in vSphere API 6.8.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.RegisterSpec" title="com.vmware.vcenter_client.VM.RegisterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.RegisterSpec</span></code></a>) – Specification of the location of the virtual machine files and the
|
|||
|
|
placement of the new virtual machine.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Identifier of the newly-created virtual machine.
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
if a virtual machine with the specified name already exists or if a
|
|||
|
|
virtual machine using the specified virtual machine files already
|
|||
|
|
exists.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if any of the specified parameters are invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if any of the resources specified in spec could not be found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if a specified resource (eg. host) is not accessible.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if any of the resources needed to register the virtual machine
|
|||
|
|
could not be allocated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user cannot be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RegisterSpec.datastore</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Folder</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.InventoryPlacementSpec.folder</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Inventory.Register</span></code>.</p></li>
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the attribute
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.ComputePlacementSpec.resource_pool</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Resource.AssignVMToPool</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.unregister">
|
|||
|
|
<code class="sig-name descname">unregister</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.unregister" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Removes the virtual machine corresponding to <code class="docutils literal notranslate"><span class="pre">vm</span></code> from the vCenter
|
|||
|
|
inventory without removing any of the virtual machine’s files from
|
|||
|
|
storage. All high-level information stored with the management server
|
|||
|
|
(ESXi or vCenter) is removed, including information such as statistics,
|
|||
|
|
resource pool association, permissions, and alarms. This method was
|
|||
|
|
added in vSphere API 6.8.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine to be unregistered.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is running (powered on).</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if there is no virtual machine associated with <code class="docutils literal notranslate"><span class="pre">vm</span></code> in the
|
|||
|
|
system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.Inventory.Unregister</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
<a href="com.vmware.appliance.html" class="btn btn-neutral float-right" title="com.vmware.appliance package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="com.html" class="btn btn-neutral float-left" title="com package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
© Copyright 2019, VMware, Inc.
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|