mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 01:39:58 -05:00
12608 lines
1.1 MiB
12608 lines
1.1 MiB
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<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. 7.0.1.0 documentation</title>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
<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" alt="Documentation Home"> vSphere Automation SDK for Python.
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
7.0.1.0
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="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>
|
||
<li class="toctree-l4"><a class="reference internal" href="#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">vSphere Automation SDK for Python.</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="index.html" class="icon icon-home"></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.security_client">com.vmware.appliance.system.security_client module</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>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.appliance.vcenter.html">com.vmware.appliance.vcenter package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.html">com.vmware.appliance.vcenter.settings package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html">com.vmware.appliance.vcenter.settings.v1 package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html">com.vmware.appliance.vcenter.settings.v1.config package</a><ul>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html#module-com.vmware.appliance.vcenter.settings.v1.config.components_client">com.vmware.appliance.vcenter.settings.v1.config.components_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#module-com.vmware.appliance.vcenter.settings.v1.config_client">com.vmware.appliance.vcenter.settings.v1.config_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.html#module-com.vmware.appliance.vcenter.settings.v1_client">com.vmware.appliance.vcenter.settings.v1_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</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.infraprofile_client">com.vmware.appliance.infraprofile_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.supportbundle_client">com.vmware.appliance.supportbundle_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.esx.html">com.vmware.esx package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.hcl.html">com.vmware.esx.hcl package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.hcl.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.hcl.html#module-com.vmware.esx.hcl.hosts_client">com.vmware.esx.hcl.hosts_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.hosts.html">com.vmware.esx.hosts package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.hosts.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.hosts.health.html">com.vmware.esx.hosts.health package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.hosts.health.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.hosts.health.html#module-com.vmware.esx.hosts.health.perspectives_client">com.vmware.esx.hosts.health.perspectives_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.hosts.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.hosts.html#module-com.vmware.esx.hosts.software_client">com.vmware.esx.hosts.software_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.html">com.vmware.esx.settings.clusters package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html">com.vmware.esx.settings.clusters.policies package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#module-com.vmware.esx.settings.clusters.policies.apply_client">com.vmware.esx.settings.clusters.policies.apply_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html">com.vmware.esx.settings.clusters.software package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html">com.vmware.esx.settings.clusters.software.drafts package</a><ul>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#module-com.vmware.esx.settings.clusters.software.drafts.software_client">com.vmware.esx.settings.clusters.software.drafts.software_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html">com.vmware.esx.settings.clusters.software.reports package</a><ul>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client">com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#module-com.vmware.esx.settings.clusters.software.drafts_client">com.vmware.esx.settings.clusters.software.drafts_client module</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#module-com.vmware.esx.settings.clusters.software.reports_client">com.vmware.esx.settings.clusters.software.reports_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.enablement_client">com.vmware.esx.settings.clusters.enablement_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.policies_client">com.vmware.esx.settings.clusters.policies_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.software_client">com.vmware.esx.settings.clusters.software_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.defaults.html">com.vmware.esx.settings.defaults package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.defaults.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html">com.vmware.esx.settings.defaults.clusters package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html">com.vmware.esx.settings.defaults.clusters.policies package</a><ul>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html#module-com.vmware.esx.settings.defaults.clusters.policies.apply_client">com.vmware.esx.settings.defaults.clusters.policies.apply_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#module-com.vmware.esx.settings.defaults.clusters.policies_client">com.vmware.esx.settings.defaults.clusters.policies_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.defaults.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.defaults.html#module-com.vmware.esx.settings.defaults.clusters_client">com.vmware.esx.settings.defaults.clusters_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html">com.vmware.esx.settings.depot_content package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#module-com.vmware.esx.settings.depot_content.add_ons_client">com.vmware.esx.settings.depot_content.add_ons_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#module-com.vmware.esx.settings.depot_content.base_images_client">com.vmware.esx.settings.depot_content.base_images_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#module-com.vmware.esx.settings.depot_content.components_client">com.vmware.esx.settings.depot_content.components_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html">com.vmware.esx.settings.hardware_support package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html">com.vmware.esx.settings.hardware_support.managers package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#module-com.vmware.esx.settings.hardware_support.managers.packages_client">com.vmware.esx.settings.hardware_support.managers.packages_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#module-com.vmware.esx.settings.hardware_support.managers_client">com.vmware.esx.settings.hardware_support.managers_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.clusters_client">com.vmware.esx.settings.clusters_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.defaults_client">com.vmware.esx.settings.defaults_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.depot_content_client">com.vmware.esx.settings.depot_content_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.depots_client">com.vmware.esx.settings.depots_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.hardware_support_client">com.vmware.esx.settings.hardware_support_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.hosts_client">com.vmware.esx.settings.hosts_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.html#module-com.vmware.esx.hcl_client">com.vmware.esx.hcl_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.html#module-com.vmware.esx.hosts_client">com.vmware.esx.hosts_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.html#module-com.vmware.esx.settings_client">com.vmware.esx.settings_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#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html">com.vmware.vcenter.compute.policies.capabilities.vm package</a><ul>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html#subpackages">Subpackages</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<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.cluster_scale_in_ignore_vm_capabilities_client">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_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.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.content.html">com.vmware.vcenter.content package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.content.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.content.registries.html">com.vmware.vcenter.content.registries package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.content.registries.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.content.registries.html#module-com.vmware.vcenter.content.registries.harbor_client">com.vmware.vcenter.content.registries.harbor_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.content.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.content.html#module-com.vmware.vcenter.content.registries_client">com.vmware.vcenter.content.registries_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>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.html#module-com.vmware.vcenter.deployment.migrate_client">com.vmware.vcenter.deployment.migrate_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.lcm.html">com.vmware.vcenter.lcm package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.lcm.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.lcm.html#module-com.vmware.vcenter.lcm.discovery_client">com.vmware.vcenter.lcm.discovery_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.lcm.html#module-com.vmware.vcenter.lcm.update_client">com.vmware.vcenter.lcm.update_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html">com.vmware.vcenter.namespace_management package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#module-com.vmware.vcenter.namespace_management.software_client">com.vmware.vcenter.namespace_management.software_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#module-com.vmware.vcenter.namespace_management.stats_client">com.vmware.vcenter.namespace_management.stats_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespaces.html">com.vmware.vcenter.namespaces package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespaces.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespaces.html#module-com.vmware.vcenter.namespaces.user_client">com.vmware.vcenter.namespaces.user_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.trusted_infrastructure.html">com.vmware.vcenter.trusted_infrastructure package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os package</a><ul>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers package</a><ul>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html">com.vmware.vcenter.trusted_infrastructure.trusted_clusters package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.attestation_client">com.vmware.vcenter.trusted_infrastructure.attestation_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.kms_client">com.vmware.vcenter.trusted_infrastructure.kms_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client">com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client module</a></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.guest.html">com.vmware.vcenter.vm.guest package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html#module-com.vmware.vcenter.vm.guest.networking_client">com.vmware.vcenter.vm.guest.networking_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<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.console_client">com.vmware.vcenter.vm.console_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>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.tools_client">com.vmware.vcenter.vm.tools_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.lcm_client">com.vmware.vcenter.lcm_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.namespace_management_client">com.vmware.vcenter.namespace_management_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.namespaces_client">com.vmware.vcenter.namespaces_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.tagging_client">com.vmware.vcenter.tagging_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.trusted_infrastructure_client">com.vmware.vcenter.trusted_infrastructure_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="py 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"><span class="n">config</span></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="py 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"><span class="n">item</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">old_password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">full_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">email</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">roles</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password_expires</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password_expires_at</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inactive_after_password_expiration</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">days_after_password_expiration</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">min_days_between_password_change</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_days_between_password_change</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">warn_days_before_password_expiration</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">fullname</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">email</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">roles</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">has_password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_password_change</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password_expires_at</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inactive_at</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">min_days_between_password_change</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_days_between_password_change</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">warn_days_before_password_expiration</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">old_password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">full_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">email</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">roles</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password_expires</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password_expires_at</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inactive_after_password_expiration</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">days_after_password_expiration</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">min_days_between_password_change</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_days_between_password_change</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">warn_days_before_password_expiration</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">username</span></em>, <em class="sig-param"><span class="n">config</span></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="py 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"><span class="n">username</span></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="py 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"><span class="n">username</span></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="py 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="py 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"><span class="n">username</span></em>, <em class="sig-param"><span class="n">config</span></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="py 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"><span class="n">username</span></em>, <em class="sig-param"><span class="n">config</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">string</span></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="py 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="py 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="py 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="py 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="py 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"><span class="n">string</span></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="py 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="py 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="py 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="py 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="py 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="py 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"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">units</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">instance</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interval</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">function</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">names</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interval</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">function</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">stat_id</span></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="py 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="py 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"><span class="n">item</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">hostname</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sso_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sso_password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">dns</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ipv4</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ipv6</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">mode</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hostname</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">servers</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">string</span></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="py 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="py 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="py 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"><span class="n">dns</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interfaces</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">ipv6_enabled</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">spec</span></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="py 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="py 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="py 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"><span class="n">spec</span></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="py 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"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">message</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resolution</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">info</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">warnings</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">errors</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">default_message</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">args</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">string</span></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="py 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="py 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="py 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"><span class="n">server</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">message</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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"><span class="n">servers</span></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="py 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"><span class="n">servers</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">supported</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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"><span class="n">config</span></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="py 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"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">string</span></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="py 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="py 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="py 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="py 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="py 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"><span class="n">service</span></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="py 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="py 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"><span class="n">service</span></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 StartupType#DISABLED</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="py 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"><span class="n">service</span></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
|
||
StartupType#DISABLED.</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="py 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"><span class="n">service</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">shutdown_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">action</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">reason</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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="py 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"><span class="n">delay</span></em>, <em class="sig-param"><span class="n">reason</span></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="py 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"><span class="n">delay</span></em>, <em class="sig-param"><span class="n">reason</span></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="py 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"><span class="n">stub_config</span></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="py 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"><span class="n">progress</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">service</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cancelable</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user</span><span class="o">=</span><span class="default_value">None</span></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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.CommonInfo.status</span></code> 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="py 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"><span class="n">progress</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">subtask_order</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">subtasks</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">service</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cancelable</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">string</span></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="py 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="py 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="py 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="py 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="py 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"><span class="n">mode</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">task</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">latest_query_time</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">string</span></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="py 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="py 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="py 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="py 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="py 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="py 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="py 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="py 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="py 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"><span class="n">config</span></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="py 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"><span class="n">user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">created_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_accessed_time</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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="py 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="py 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"><span class="n">stub_config</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">tasks</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">services</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operations</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">targets</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">users</span><span class="o">=</span><span class="default_value">None</span></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>operations</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>) – <p>Identifiers of operations. Tasks created by these operations match
|
||
the filter (see
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.CommonInfo.operation</span></code>).</p>
|
||
<p>Note that an operation identifier by itself is not globally unique.
|
||
To filter on an operation, the identifier of the service interface
|
||
containing the operation should also be specified in <code class="docutils literal notranslate"><span class="pre">services</span></code>..
|
||
This attribute was added in vSphere API 7.0.0.0.
|
||
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.operation</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.operation</span></code>.
|
||
If None or empty, tasks associated with any operation will match
|
||
the filter.</p>
|
||
</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="py 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"><span class="n">return_all</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">exclude_result</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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"><span class="n">task</span></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="py 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"><span class="n">task</span></em>, <em class="sig-param"><span class="n">spec</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">filter_spec</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result_spec</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">config</span></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="py 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="py 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"><span class="n">model</span></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="py 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"><span class="n">automatic_sync_enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">automatic_sync_start_hour</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">automatic_sync_stop_hour</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">maximum_concurrent_item_syncs</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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"><span class="n">spec</span></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="py 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"><span class="n">library_id</span></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="py 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="py 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"><span class="n">library_id</span></em>, <em class="sig-param"><span class="n">update_spec</span></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="py 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"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">creation_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_sync_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">storage_backings</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">optimization_info</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">publish_info</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">subscription_info</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">server_guid</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">string</span></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="py 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="py 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="py 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"><span class="n">config</span></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="py 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"><span class="n">subscription</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">create_spec</span></em>, <em class="sig-param"><span class="n">client_token</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">library_id</span></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="py 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"><span class="n">library_id</span></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="py 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="py 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"><span class="n">library_id</span></em>, <em class="sig-param"><span class="n">subscriptions</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">library_id</span></em>, <em class="sig-param"><span class="n">update_spec</span></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="py 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"><span class="n">stub_config</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ssl_thumbprint</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_messages</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">string</span></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="py 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 #sslThumbprint 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="py 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="py 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="py 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="py 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="py 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="py 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="py 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="py 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"><span class="n">create_spec</span></em>, <em class="sig-param"><span class="n">client_token</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">library_id</span></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="py 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"><span class="n">library_id</span></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="py 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"><span class="n">library_id</span></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="py 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="py 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"><span class="n">subscription_info</span></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="py 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"><span class="n">library_id</span></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="py 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"><span class="n">library_id</span></em>, <em class="sig-param"><span class="n">update_spec</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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"><span class="n">stub_config</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">clusters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">names</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">folders</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datacenters</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_pool</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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"><span class="n">cluster</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ha_enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">drs_enabled</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">cluster</span></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>Information about the cluster associated with <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="py 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"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">folder</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">datacenters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">names</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">folders</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datastore_folder</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_folder</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">network_folder</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vm_folder</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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"><span class="n">datacenter</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">spec</span></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 a 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="py 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"><span class="n">datacenter</span></em>, <em class="sig-param"><span class="n">force</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">datacenter</span></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>Information about the datacenter associated with <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="py 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"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">datastores</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">names</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">types</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">folders</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datacenters</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">accessible</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">free_space</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">multiple_host_access</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">thin_provisioning_supported</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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"><span class="n">datastore</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">free_space</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">capacity</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">string</span></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="py 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="py 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="py 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="py 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="py 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="py 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="py 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="py 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"><span class="n">datastore</span></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 associated with <code class="docutils literal notranslate"><span class="pre">datastore</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 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="py 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"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">progress</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">subtask_order</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">subtasks</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">service</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cancelable</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">progress</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">service</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cancelable</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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="py 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"><span class="n">config</span></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="py 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"><span class="n">folders</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">names</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_folders</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datacenters</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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"><span class="n">folder</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">string</span></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="py 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="py 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="py 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="py 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="py 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="py 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"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">string</span></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="py 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="py 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="py 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="py 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"><span class="n">hostname</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">port</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">folder</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">thumbprint_verification</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">thumbprint</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">force_add</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">string</span></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="py 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="py 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="py 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"><span class="n">hosts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">names</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">folders</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datacenters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">standalone</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">clusters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">connection_states</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">string</span></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="py 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="py 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="py 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="py 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="py 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"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">connection_state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">power_state</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">host</span></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="py 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"><span class="n">spec</span></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="py 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"><span class="n">host</span></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="py 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"><span class="n">host</span></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="py 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"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">config</span></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="py 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"><span class="n">networks</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">names</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">types</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">folders</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datacenters</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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"><span class="n">network</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">string</span></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="py 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>Distributed virtual portgroup (created and managed through vCenter)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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 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="py 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>vSphere standard portgroup (created and managed on ESX)</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py 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"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">config</span></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="py class">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.CreateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cpu_allocation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">memory_allocation</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.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 class contains information used to create a resource pool, see
|
||
<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.create" title="com.vmware.vcenter_client.ResourcePool.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResourcePool.create()</span></code></a>. This class was added in vSphere API 7.0.0.0.</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 resource pool. This attribute was added in vSphere API
|
||
7.0.0.0.</p></li>
|
||
<li><p><strong>parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Parent of the created resource pool. This attribute was added in
|
||
vSphere API 7.0.0.0.
|
||
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>cpu_allocation</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.ResourceAllocationCreateSpec" title="com.vmware.vcenter_client.ResourcePool.ResourceAllocationCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.ResourceAllocationCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource allocation for CPU. This attribute was added in vSphere
|
||
API 7.0.0.0.
|
||
if None or empty, use the default CPU allocation specification.</p></li>
|
||
<li><p><strong>memory_allocation</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.ResourceAllocationCreateSpec" title="com.vmware.vcenter_client.ResourcePool.ResourceAllocationCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.ResourceAllocationCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource allocation for memory. This attribute was added in vSphere
|
||
API 7.0.0.0.
|
||
if None or empty, use the default memory allocation specification.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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"><span class="n">resource_pools</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">names</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_resource_pools</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datacenters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hosts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">clusters</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_pools</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cpu_allocation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">memory_allocation</span><span class="o">=</span><span class="default_value">None</span></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>
|
||
<li><p><strong>cpu_allocation</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.ResourceAllocationInfo" title="com.vmware.vcenter_client.ResourcePool.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.ResourceAllocationInfo</span></code></a>) – Resource allocation information for CPU. This attribute was added
|
||
in vSphere API 7.0.0.0.
|
||
This attribute is optional because it was added in a newer version
|
||
than its parent node.</p></li>
|
||
<li><p><strong>memory_allocation</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.ResourceAllocationInfo" title="com.vmware.vcenter_client.ResourcePool.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.ResourceAllocationInfo</span></code></a>) – Resource allocation information for memory. This attribute was
|
||
added in vSphere API 7.0.0.0.
|
||
This attribute is optional because it was added in a newer version
|
||
than its parent node.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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="py class">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.ResourceAllocationCreateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">ResourceAllocationCreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">reservation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">expandable_reservation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">limit</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">shares</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.ResourceAllocationCreateSpec" 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.ResourceAllocationCreateSpec</span></code> class contains resource
|
||
allocation information used to create a resource pool, see
|
||
<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.create" title="com.vmware.vcenter_client.ResourcePool.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResourcePool.create()</span></code></a>. This class was added in vSphere API 7.0.0.0.</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>reservation</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>) – Amount of resource that is guaranteed available to a resource pool.
|
||
Reserved resources are not wasted if they are not used. If the
|
||
utilization is less than the reservation, the resources can be
|
||
utilized by other running virtual machines. Units are MB fo memory,
|
||
and MHz for CPU. This attribute was added in vSphere API 7.0.0.0.
|
||
If None or empty,
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourcePool.ResourceAllocationCreateSpec.reservation</span></code> will
|
||
be set to 0.</p></li>
|
||
<li><p><strong>expandable_reservation</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>) – In a resource pool with an expandable reservation, the reservation
|
||
can grow beyond the specified value, if the parent resource pool
|
||
has unreserved resources. A non-expandable reservation is called a
|
||
fixed reservation. This attribute was added in vSphere API 7.0.0.0.
|
||
If None or empty,
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourcePool.ResourceAllocationCreateSpec.expandable_reservation</span></code>
|
||
will be set to true.</p></li>
|
||
<li><p><strong>limit</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 utilization of a resource pool will not exceed this limit, even
|
||
if there are available resources. This is typically used to ensure
|
||
a consistent performance of resource pools independent of available
|
||
resources. If set to -1, then there is no fixed limit on resource
|
||
usage (only bounded by available resources and shares). Units are
|
||
MB for memory, and MHz for CPU. This attribute was added in vSphere
|
||
API 7.0.0.0.
|
||
If None or empty,
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourcePool.ResourceAllocationCreateSpec.limit</span></code> will be set
|
||
to -1.</p></li>
|
||
<li><p><strong>shares</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo" title="com.vmware.vcenter_client.ResourcePool.SharesInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.SharesInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Shares are used in case of resource contention. This attribute was
|
||
added in vSphere API 7.0.0.0.
|
||
If None or empty,
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourcePool.ResourceAllocationCreateSpec.shares</span></code> will be
|
||
set to ‘<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.NORMAL" title="com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.NORMAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourcePool.SharesInfo.Level.NORMAL</span></code></a>’.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.ResourceAllocationInfo">
|
||
<em class="property">class </em><code class="sig-name descname">ResourceAllocationInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">reservation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">expandable_reservation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">limit</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">shares</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.ResourceAllocationInfo" 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.ResourceAllocationInfo</span></code> class contains resource
|
||
allocation information of a resource pool. This class was added in vSphere
|
||
API 7.0.0.0.</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>reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Amount of resource that is guaranteed available to a resource pool.
|
||
Reserved resources are not wasted if they are not used. If the
|
||
utilization is less than the reservation, the resources can be
|
||
utilized by other running virtual machines. Units are MB fo memory,
|
||
and MHz for CPU. This attribute was added in vSphere API 7.0.0.0.</p></li>
|
||
<li><p><strong>expandable_reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – In a resource pool with an expandable reservation, the reservation
|
||
can grow beyond the specified value, if the parent resource pool
|
||
has unreserved resources. A non-expandable reservation is called a
|
||
fixed reservation. This attribute was added in vSphere API 7.0.0.0.</p></li>
|
||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The utilization of a resource pool will not exceed this limit, even
|
||
if there are available resources. This is typically used to ensure
|
||
a consistent performance of resource pools independent of available
|
||
resources. If set to -1, then there is no fixed limit on resource
|
||
usage (only bounded by available resources and shares). Units are
|
||
MB for memory, and MHz for CPU. This attribute was added in vSphere
|
||
API 7.0.0.0.</p></li>
|
||
<li><p><strong>shares</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo" title="com.vmware.vcenter_client.ResourcePool.SharesInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.SharesInfo</span></code></a>) – Shares are used in case of resource contention. This attribute was
|
||
added in vSphere API 7.0.0.0.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.ResourceAllocationUpdateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">ResourceAllocationUpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">reservation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">expandable_reservation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">limit</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">shares</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.ResourceAllocationUpdateSpec" 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">ResourceAllocationUpdateSpec</span></code> class descrives the updates to be made
|
||
to the resource allocation settings of a resource pool. This class was
|
||
added in vSphere API 7.0.0.0.</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>reservation</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>) – Amount of resource that is guaranteed available to a resource pool.
|
||
Reserved resources are not wasted if they are not used. If the
|
||
utilization is less than the reservation, the resources can be
|
||
utilized by other running virtual machines. Units are MB fo memory,
|
||
and MHz for CPU. This attribute was added in vSphere API 7.0.0.0.
|
||
If None or empty, <code class="docutils literal notranslate"><span class="pre">reservation</span></code> will be set to 0.</p></li>
|
||
<li><p><strong>expandable_reservation</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>) – In a resource pool with an expandable reservation, the reservation
|
||
can grow beyond the specified value, if the parent resource pool
|
||
has unreserved resources. A non-expandable reservation is called a
|
||
fixed reservation. This attribute was added in vSphere API 7.0.0.0.
|
||
If None or empty, <code class="docutils literal notranslate"><span class="pre">expandableReservation</span></code> will be set to true.</p></li>
|
||
<li><p><strong>limit</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 utilization of a resource pool will not exceed this limit, even
|
||
if there are available resources. This is typically used to ensure
|
||
a consistent performance of resource pools independent of available
|
||
resources. If set to -1, then there is no fixed limit on resource
|
||
usage (only bounded by available resources and shares). Units are
|
||
MB for memory, and MHz for CPU. This attribute was added in vSphere
|
||
API 7.0.0.0.
|
||
If None or empty, <code class="docutils literal notranslate"><span class="pre">limit</span></code> will be set to -1.</p></li>
|
||
<li><p><strong>shares</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo" title="com.vmware.vcenter_client.ResourcePool.SharesInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.SharesInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Shares are used in case of resource contention. This attribute was
|
||
added in vSphere API 7.0.0.0.
|
||
If None or empty, <code class="docutils literal notranslate"><span class="pre">shares</span></code> will be set to
|
||
‘<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.NORMAL" title="com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.NORMAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourcePool.SharesInfo.Level.NORMAL</span></code></a>’.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.SharesInfo">
|
||
<em class="property">class </em><code class="sig-name descname">SharesInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">level</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">shares</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo" 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.SharesInfo</span></code> class provides specification of shares.</p>
|
||
<p>Shares are used to determine relative allocation between resource
|
||
consumers. In general, a consumer with more shares gets proportionally more
|
||
of the resource, subject to certain other constraints.. This class was
|
||
added in vSphere API 7.0.0.0.</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>level</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo.Level" title="com.vmware.vcenter_client.ResourcePool.SharesInfo.Level"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.SharesInfo.Level</span></code></a>) – The allocation level. It maps to a pre-determined set of numeric
|
||
values for shares. If the shares value does not map to a predefined
|
||
size, then the level is set as CUSTOM. This attribute was added in
|
||
vSphere API 7.0.0.0.</p></li>
|
||
<li><p><strong>shares</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – <p>When <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourcePool.SharesInfo.level</span></code> is set to CUSTOM, it is
|
||
the number of shares allocated. Otherwise, this value is ignored.</p>
|
||
<p>There is no unit for this value. It is a relative measure based on
|
||
the settings for other resource pools.. This attribute was added in
|
||
vSphere API 7.0.0.0.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">level</span></code> is <a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.CUSTOM" title="com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.CUSTOM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourcePool.SharesInfo.Level.CUSTOM</span></code></a>.</p>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.SharesInfo.Level">
|
||
<em class="property">class </em><code class="sig-name descname">Level</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo.Level" 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">ResourcePool.SharesInfo.Level</span></code> class defines the possible values for
|
||
the allocation level. This enumeration was added in vSphere API 7.0.0.0.</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">Level</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.CUSTOM">
|
||
<code class="sig-name descname">CUSTOM</code><em class="property"> = Level(string='CUSTOM')</em><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.CUSTOM" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, in case there is resource contention the server uses the
|
||
shares value to determine the resource allocation. This class attribute was
|
||
added in vSphere API 7.0.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.HIGH">
|
||
<code class="sig-name descname">HIGH</code><em class="property"> = Level(string='HIGH')</em><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.HIGH" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="simple">
|
||
<dt>For CPU: Shares = 2000 * nmumber of virtual CPUs.</dt><dd><p>For Memory: Shares = 20 * virtual machine memory size in MB.</p>
|
||
</dd>
|
||
</dl>
|
||
<p>. This class attribute was added in vSphere API 7.0.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.LOW">
|
||
<code class="sig-name descname">LOW</code><em class="property"> = Level(string='LOW')</em><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.LOW" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="simple">
|
||
<dt>For CPU: Shares = 500 * number of virtual CPUs.</dt><dd><p>For Memory: Shares = 5 * virtual machine memory size in MB.</p>
|
||
</dd>
|
||
</dl>
|
||
<p>. This class attribute was added in vSphere API 7.0.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.NORMAL">
|
||
<code class="sig-name descname">NORMAL</code><em class="property"> = Level(string='NORMAL')</em><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.SharesInfo.Level.NORMAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="simple">
|
||
<dt>For CPU: Shares = 1000 * number of virtual CPUs.</dt><dd><p>For Memory: Shares = 10 * virtual machine memory size in MB.</p>
|
||
</dd>
|
||
</dl>
|
||
<p>. This class attribute was added in vSphere API 7.0.0.0.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py 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"><span class="n">resource_pool</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></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="py class">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.UpdateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cpu_allocation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">memory_allocation</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.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 class contains specification for updating the configuration of a
|
||
resource pool. This class was added in vSphere API 7.0.0.0.</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 resource pool. This attribute was added in vSphere API
|
||
7.0.0.0.
|
||
if None or empty, the name of the resource pool will not be
|
||
changed.</p></li>
|
||
<li><p><strong>cpu_allocation</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.ResourceAllocationUpdateSpec" title="com.vmware.vcenter_client.ResourcePool.ResourceAllocationUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.ResourceAllocationUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource allocation for CPU. This attribute was added in vSphere
|
||
API 7.0.0.0.
|
||
if None or empty, the CPU allocation of the resource pool will not
|
||
be changed.</p></li>
|
||
<li><p><strong>memory_allocation</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.ResourceAllocationUpdateSpec" title="com.vmware.vcenter_client.ResourcePool.ResourceAllocationUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.ResourceAllocationUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource allocation for memory. This attribute was added in vSphere
|
||
API 7.0.0.0.
|
||
if None or empty, the memory allocation of the resource pool will
|
||
not be changed.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.create">
|
||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.create" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Creates a resource pool. This method was added in vSphere API 7.0.0.0.</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.ResourcePool.CreateSpec" title="com.vmware.vcenter_client.ResourcePool.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.CreateSpec</span></code></a>) – Specification of the new resource pool to be created, see
|
||
<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.CreateSpec" title="com.vmware.vcenter_client.ResourcePool.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.CreateSpec</span></code></a>.</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 resource pool.
|
||
The return value will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ResourcePool</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.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 parameter passed in the spec 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.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 specified in parent could not 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.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 specified resource in parent is not accessible.</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 resource pool 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.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 attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourcePool.CreateSpec.parent</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">Resource.CreatePool</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.delete">
|
||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">resource_pool</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deletes a resource pool. This method was added in vSphere API 7.0.0.0.</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 to be deleted.
|
||
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">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 resource pool 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.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 resource pool is a root resource pool.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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"><span class="n">resource_pool</span></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="py 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"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></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>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vcenter_client.ResourcePool.update">
|
||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">resource_pool</span></em>, <em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Updates the configuration of a resource pool. This method was added in
|
||
vSphere API 7.0.0.0.</p>
|
||
<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.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.UpdateSpec" title="com.vmware.vcenter_client.ResourcePool.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.UpdateSpec</span></code></a>) – Specification for updating the configuration of the resource pool.</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.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 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.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 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.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 reconfigure the resource pool
|
||
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">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">Resource.EditPool</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py 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"><span class="n">stub_config</span></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="py 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"><span class="n">config</span></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="py class">
|
||
<dt id="com.vmware.vcenter_client.VM.ClonePlacementSpec">
|
||
<em class="property">class </em><code class="sig-name descname">ClonePlacementSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">folder</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_pool</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cluster</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datastore</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.ClonePlacementSpec" 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.ClonePlacementSpec</span></code> class contains information used to place a
|
||
clone of a virtual machine onto resources within the vCenter inventory.
|
||
This class was added in vSphere API 7.0.0.0.</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 cloned virtual machine should
|
||
be placed. This attribute was added in vSphere API 7.0.0.0.
|
||
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. If this results in a conflict
|
||
due to other placement parameters, the virtual machine clone
|
||
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 cloned virtual machine should be
|
||
placed. This attribute was added in vSphere API 7.0.0.0.
|
||
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. If this results in a conflict due to other
|
||
placement parameters, the virtual machine clone 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 cloned 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>.. This attribute was added in vSphere API
|
||
7.0.0.0.
|
||
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>.
|
||
If this attribute is unset, if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> is unset, the
|
||
cloned virtual machine will use the host of the source virtual
|
||
machine. if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> is set, and the target is a standalone
|
||
host, the host is used. if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> is set, and the target
|
||
is a DRS cluster, a host will be picked by DRS. if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code>
|
||
is set, and the target is a cluster without DRS, InvalidArgument
|
||
will be thrown.</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 cloned 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>.. This attribute was added in vSphere API
|
||
7.0.0.0.
|
||
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 cloned 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 clone
|
||
operation unless individually overridden. This attribute was added
|
||
in vSphere API 7.0.0.0.
|
||
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="py class">
|
||
<dt id="com.vmware.vcenter_client.VM.CloneSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CloneSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">source</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">placement</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">disks_to_remove</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">disks_to_update</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">power_on</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">guest_customization_spec</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.CloneSpec" 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 clone spec. This class was added in vSphere API 7.0.0.0.</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 clone from. This attribute was added in vSphere
|
||
API 7.0.0.0.
|
||
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>) – Virtual machine name. This attribute was added in vSphere API
|
||
7.0.0.0.</p></li>
|
||
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.ClonePlacementSpec" title="com.vmware.vcenter_client.VM.ClonePlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.ClonePlacementSpec</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 7.0.0.0.
|
||
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>disks_to_remove</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>) – Set of Disks to Remove. This attribute was added in vSphere API
|
||
7.0.0.0.
|
||
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.vcenter.vm.hardware.Disk</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.vcenter.vm.hardware.Disk</span></code>.
|
||
If None, all disks will be copied. If the same identifier is in
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.CloneSpec.disks_to_update</span></code> InvalidArgument fault will be
|
||
returned.</p></li>
|
||
<li><p><strong>disks_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_client.VM.DiskCloneSpec" title="com.vmware.vcenter_client.VM.DiskCloneSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.DiskCloneSpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Map of Disks to Update. This attribute was added in vSphere API
|
||
7.0.0.0.
|
||
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>.
|
||
If None, all disks will copied to the datastore specified in the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.ClonePlacementSpec.datastore</span></code> attribute of
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.CloneSpec.placement</span></code>. If the same identifier is in
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.CloneSpec.disks_to_remove</span></code> InvalidArgument fault will be
|
||
thrown.</p></li>
|
||
<li><p><strong>power_on</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Attempt to perform a <code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.CloneSpec.power_on</span></code> after clone.
|
||
This attribute was added in vSphere API 7.0.0.0.
|
||
If None, the virtual machine will not be powered on.</p></li>
|
||
<li><p><strong>guest_customization_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.GuestCustomizationSpec" title="com.vmware.vcenter_client.VM.GuestCustomizationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.GuestCustomizationSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Guest customization spec to apply to the virtual machine after the
|
||
virtual machine is deployed. This attribute was added in vSphere
|
||
API 7.0.0.0.
|
||
If None, the guest operating system is not customized after clone.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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"><span class="n">resource_pool</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cluster</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">guest_os</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">placement</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hardware_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">boot</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">boot_devices</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cpu</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">memory</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">disks</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">nics</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cdroms</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">floppies</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parallel_ports</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">serial_ports</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sata_adapters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">scsi_adapters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">storage_policy</span><span class="o">=</span><span class="default_value">None</span></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="py class">
|
||
<dt id="com.vmware.vcenter_client.VM.DiskCloneSpec">
|
||
<em class="property">class </em><code class="sig-name descname">DiskCloneSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">datastore</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.DiskCloneSpec" 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 disk clone spec. This class was added in vSphere API
|
||
7.0.0.0.</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>) – Destination datastore to clone disk. This attribute was added in
|
||
vSphere API 7.0.0.0.
|
||
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 disk will be copied to the datastore specified in
|
||
the <code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.ClonePlacementSpec.datastore</span></code> attribute of
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.CloneSpec.placement</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter_client.VM.DiskRelocateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">DiskRelocateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">datastore</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.DiskRelocateSpec" 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 disk relocate spec. This class was added in vSphere API
|
||
7.0.0.0.</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>) – Destination datastore to relocate disk. This attribute was added in
|
||
vSphere API 7.0.0.0.
|
||
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 unset, disk will use the datastore specified in
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RelocatePlacementSpec.datastore</span></code> attribute of
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RelocateSpec.placement</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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"><span class="n">vms</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">names</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">folders</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datacenters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hosts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">clusters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_pools</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">power_states</span><span class="o">=</span><span class="default_value">None</span></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="py class">
|
||
<dt id="com.vmware.vcenter_client.VM.GuestCustomizationSpec">
|
||
<em class="property">class </em><code class="sig-name descname">GuestCustomizationSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.GuestCustomizationSpec" 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.GuestCustomizationSpec</span></code> class contains information required to
|
||
customize a virtual machine when deploying it. This class was added in
|
||
vSphere API 7.0.0.0.</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>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 customization specification. This attribute was added
|
||
in vSphere API 7.0.0.0.
|
||
If None, no guest customization is performed.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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"><span class="n">guest_os</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">identity</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">power_state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">instant_clone_frozen</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hardware</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">boot</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">boot_devices</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cpu</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">memory</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">disks</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">nics</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cdroms</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">floppies</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parallel_ports</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">serial_ports</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sata_adapters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">scsi_adapters</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">folder</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_pool</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datastore</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">source</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">placement</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">nics_to_update</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">disconnect_all_nics</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parallel_ports_to_update</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">serial_ports_to_update</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">bios_uuid</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">folder</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">folder</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_pool</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cluster</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datastore</span><span class="o">=</span><span class="default_value">None</span></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="py 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="py 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"><span class="n">folder</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_pool</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cluster</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">datastore</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datastore_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">placement</span><span class="o">=</span><span class="default_value">None</span></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="py class">
|
||
<dt id="com.vmware.vcenter_client.VM.RelocatePlacementSpec">
|
||
<em class="property">class </em><code class="sig-name descname">RelocatePlacementSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">folder</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_pool</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cluster</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datastore</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.RelocatePlacementSpec" 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.RelocatePlacementSpec</span></code> class contains information used to change
|
||
the placement of an existing virtual machine within the vCenter inventory.
|
||
This class was added in vSphere API 7.0.0.0.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual machine folder into which the virtual machine should be
|
||
placed. This attribute was added in vSphere API 7.0.0.0.
|
||
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 this attribute is None, the virtual machine will stay in the
|
||
current folder.</p></li>
|
||
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Resource pool into which the virtual machine should be placed. This
|
||
attribute was added in vSphere API 7.0.0.0.
|
||
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 this attribute is None, the virtual machine will stay in the
|
||
current resource pool.</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>.. This attribute was added in vSphere API
|
||
7.0.0.0.
|
||
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>.
|
||
If this attribute is unset, if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> is unset, the
|
||
virtual machine will remain on the current host. if
|
||
<code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> is set, and the target is a standalone host, the
|
||
host is used. if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> is set, and the target is a DRS
|
||
cluster, a host will be picked by DRS. if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> is set,
|
||
and the target is a cluster without DRS, InvalidArgument will be
|
||
thrown.</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>.. This attribute was added in vSphere API
|
||
7.0.0.0.
|
||
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 associated with the virtual machine, unless individually
|
||
overridden. This attribute was added in vSphere API 7.0.0.0.
|
||
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 this attribute is None, the virtual machine will remain on the
|
||
current datastore.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter_client.VM.RelocateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">RelocateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">placement</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">disks</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.RelocateSpec" 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 relocate spec. This class was added in vSphere API 7.0.0.0.</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>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.RelocatePlacementSpec" title="com.vmware.vcenter_client.VM.RelocatePlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.RelocatePlacementSpec</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 7.0.0.0.
|
||
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 other existing placement of
|
||
the virtual machine result in disjoint placement the operation will
|
||
fail.</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_client.VM.DiskRelocateSpec" title="com.vmware.vcenter_client.VM.DiskRelocateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.DiskRelocateSpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Individual disk relocation map. This attribute was added in vSphere
|
||
API 7.0.0.0.
|
||
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>.
|
||
If None, all disks will migrate to the datastore specified in the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RelocatePlacementSpec.datastore</span></code> attribute of
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.RelocateSpec.placement</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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"><span class="n">datastore</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">policy</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">vm</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">power_state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cpu_count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">memory_size_mib</span><span class="o">=</span><span class="default_value">None</span></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="py method">
|
||
<dt id="com.vmware.vcenter_client.VM.clone">
|
||
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.clone" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Creates a virtual machine from an existing virtual machine.</p>
|
||
<p>. This method was added in vSphere API 7.0.0.0.</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.CloneSpec" title="com.vmware.vcenter_client.VM.CloneSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.CloneSpec</span></code></a>) – Virtual machine clone 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.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 clone 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 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">Datastore</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.DiskCloneSpec.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">Datastore</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.ClonePlacementSpec.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">Folder</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.ClonePlacementSpec.folder</span></code> requires
|
||
<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">ResourcePool</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.ClonePlacementSpec.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">VirtualMachine</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.CloneSpec.source</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Provisioning.Clone</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vcenter_client.VM.clone_task">
|
||
<code class="sig-name descname">clone_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.clone_task" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Creates a virtual machine from an existing virtual machine.</p>
|
||
<p>. This method was added in vSphere API 7.0.0.0.</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.CloneSpec" title="com.vmware.vcenter_client.VM.CloneSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.CloneSpec</span></code></a>) – Virtual machine clone specification.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><dl class="field-list simple">
|
||
<dt class="field-odd">class</dt>
|
||
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Task instance</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 a virtual machine with the specified name already exists.</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 any of the specified parameters 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.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-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 specified resource (eg. host) is not accessible.</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 clone 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.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.DiskCloneSpec.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">Datastore</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.ClonePlacementSpec.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">Folder</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.ClonePlacementSpec.folder</span></code> requires
|
||
<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">ResourcePool</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.ClonePlacementSpec.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">VirtualMachine</span></code> referenced by the attribute
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.CloneSpec.source</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Provisioning.Clone</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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"><span class="n">spec</span></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,
|
||
NVMe) 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="py 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"><span class="n">vm</span></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="py 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"><span class="n">vm</span></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="py 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"><span class="n">spec</span></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="py 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"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></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="py 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"><span class="n">spec</span></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="py method">
|
||
<dt id="com.vmware.vcenter_client.VM.relocate">
|
||
<code class="sig-name descname">relocate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.relocate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Relocates a virtual machine based on the specification. The parts of
|
||
the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST,
|
||
CLUSTER and DATASTORE of home of the virtual machine and disks.</p>
|
||
<p>. This method was added in vSphere API 7.0.0.0.</p>
|
||
<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>) – Existing Virtual machine to relocate.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.RelocateSpec" title="com.vmware.vcenter_client.VM.RelocateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.RelocateSpec</span></code></a>) – Relocate specification.</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.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-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 any of the resources specified in spec or the given “vm” could
|
||
not 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.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-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.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">Resource.ColdMigrate</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.RelocatePlacementSpec.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="py method">
|
||
<dt id="com.vmware.vcenter_client.VM.relocate_task">
|
||
<code class="sig-name descname">relocate_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.relocate_task" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Relocates a virtual machine based on the specification. The parts of
|
||
the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST,
|
||
CLUSTER and DATASTORE of home of the virtual machine and disks.</p>
|
||
<p>. This method was added in vSphere API 7.0.0.0.</p>
|
||
<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>) – Existing Virtual machine to relocate.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.RelocateSpec" title="com.vmware.vcenter_client.VM.RelocateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.RelocateSpec</span></code></a>) – Relocate specification.</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.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-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 any of the resources specified in spec or the given “vm” could
|
||
not 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.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-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.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">Resource.ColdMigrate</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.RelocatePlacementSpec.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="py 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"><span class="n">vm</span></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 class="section" id="module-com.vmware.vstats_client">
|
||
<span id="com-vmware-vstats-client-module"></span><h2>com.vmware.vstats_client module<a class="headerlink" href="#module-com.vmware.vstats_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vstats_client</span></code> component provides API classes and types used
|
||
in the vStats service.</p>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">AcqSpecs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs" 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">AcqSpecs</span></code> class provides methods to perform acquisition
|
||
specification related operations. An acquisition specification defines the
|
||
statistical data that should be collected at desired sampling rates from
|
||
the underlying providers. It designates the resources and their counters
|
||
which should be sampled, and a desired sampling rate. <strong>Warning:</strong> This
|
||
class is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</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="py class">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.CounterSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CounterSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cid_mid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">set_id</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.CounterSpec" 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">AcqSpecs.CounterSpec</span></code> class designates a counter or counter set in
|
||
an acquisition specification. <strong>Warning:</strong> This class is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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>cid_mid</strong> (<a class="reference internal" href="#com.vmware.vstats_client.CidMid" title="com.vmware.vstats_client.CidMid"><code class="xref py py-class docutils literal notranslate"><span class="pre">CidMid</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Counter and optional meatadata identifier. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
When None the <code class="docutils literal notranslate"><span class="pre">setId</span></code> field will be used.</p></li>
|
||
<li><p><strong>set_id</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>) – Counter set identifier. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
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.vstats.model.CounterSet</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.vstats.model.CounterSet</span></code>.
|
||
When None the <code class="docutils literal notranslate"><span class="pre">cidMid</span></code> field will be used.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.CreateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">counters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resources</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interval</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">expiration</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">memo_</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.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">AcqSpecs.CreateSpec</span></code> class contains information for a new data
|
||
acquisition specification. <strong>Warning:</strong> This class is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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>counters</strong> (<a class="reference internal" href="#com.vmware.vstats_client.AcqSpecs.CounterSpec" title="com.vmware.vstats_client.AcqSpecs.CounterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcqSpecs.CounterSpec</span></code></a>) – Designates the counter(s) to be sampled. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.</p></li>
|
||
<li><p><strong>resources</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vstats_client.RsrcId" title="com.vmware.vstats_client.RsrcId"><code class="xref py py-class docutils literal notranslate"><span class="pre">RsrcId</span></code></a>) – A set of resource identifiers representing a single resource to be
|
||
monitored. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.</p></li>
|
||
<li><p><strong>interval</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>) – Desired sampling rate in seconds. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
If None default of 10s will be used.</p></li>
|
||
<li><p><strong>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>) – Expiration time for this acquisition specification in Unix UTC
|
||
number of seconds (since epoch). <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
When this attribute is None or 0, default expiration duration is
|
||
100 minutes.</p></li>
|
||
<li><p><strong>memo</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>) – Consumer provided text about this acquisition specification.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.
|
||
If None default empty string will be used.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.FilterSpec">
|
||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">page</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.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">AcqSpecs.FilterSpec</span></code> class contains attributes used to filter the
|
||
results when listing acquisition specifications. <strong>Warning:</strong> This class is
|
||
available as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</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>page</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>) – Used to retrieve paged data for larger result sets. The value of
|
||
this token is generated by server and returned as <code class="docutils literal notranslate"><span class="pre">next</span></code>
|
||
attribute in the result of <code class="docutils literal notranslate"><span class="pre">list</span></code> methods. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
None the first page of results will be returned.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">counters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resources</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interval</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">expiration</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">memo_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.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">AcqSpecs.Info</span></code> class is the information about an acquisition
|
||
specification. It specifies the statistical data that should be collected
|
||
at desired sampling rates. It designates the resources and their counters
|
||
which should be sampled, and a desired sampling rate. <strong>Warning:</strong> This
|
||
class is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</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>) – Acquisition specification identifier. <strong>Warning:</strong> This attribute
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
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.vstats.model.AcqSpec</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.vstats.model.AcqSpec</span></code>.</p></li>
|
||
<li><p><strong>counters</strong> (<a class="reference internal" href="#com.vmware.vstats_client.AcqSpecs.CounterSpec" title="com.vmware.vstats_client.AcqSpecs.CounterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcqSpecs.CounterSpec</span></code></a>) – Designates the counter(s) to be sampled. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.</p></li>
|
||
<li><p><strong>resources</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vstats_client.RsrcId" title="com.vmware.vstats_client.RsrcId"><code class="xref py py-class docutils literal notranslate"><span class="pre">RsrcId</span></code></a>) – A set of resource identifiers representing a single resource to be
|
||
monitored. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.</p></li>
|
||
<li><p><strong>interval</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>) – Desired sampling rate in seconds. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
When this attribute is None, default interval is 10 seconds.</p></li>
|
||
<li><p><strong>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>) – Expiration time for this acquisition specification represented as
|
||
Unix UTC number of seconds (since epoch). <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
When this attribute is None or 0, default expiration duration is
|
||
100 minutes.</p></li>
|
||
<li><p><strong>memo</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Consumer provided text about this Acquisition Specification.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vstats_client.AcqSpecs.Status" title="com.vmware.vstats_client.AcqSpecs.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcqSpecs.Status</span></code></a>) – Acquisition Specification status. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.ListResult">
|
||
<em class="property">class </em><code class="sig-name descname">ListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">acq_specs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">next</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.ListResult" 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">AcqSpecs.ListResult</span></code> class contains attributes used to return the
|
||
acquisition specifications. <strong>Warning:</strong> This class is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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>acq_specs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vstats_client.AcqSpecs.Info" title="com.vmware.vstats_client.AcqSpecs.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcqSpecs.Info</span></code></a>) – List of acquisition specifications received. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.</p></li>
|
||
<li><p><strong>next</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 <code class="docutils literal notranslate"><span class="pre">next</span></code> attribute is a token used to retrieve paged data for
|
||
larger result sets. This is opaque token generated by the server.
|
||
It is to be sent in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">AcqSpecs.FilterSpec.page</span></code> attribute
|
||
to issue a subsequent call to the list method for retrieving
|
||
results that did not fit the current page. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> when there are more results to retrieve.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.RESOURCE_TYPE">
|
||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vstats.model.AcqSpec'</em><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for acquisition specifications. <strong>Warning:</strong> This class attribute
|
||
is available as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can change based
|
||
on feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.Status">
|
||
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.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>Describes the status of an Acquisition Specification. <strong>Warning:</strong> This
|
||
enumeration is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</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="py attribute">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.Status.DISABLED">
|
||
<code class="sig-name descname">DISABLED</code><em class="property"> = Status(string='DISABLED')</em><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.Status.DISABLED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The acquisition specification is disabled when the stats data collection is
|
||
paused. This can happen when the counters are enabled or disabled
|
||
dynamically on providers. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.Status.ENABLED">
|
||
<code class="sig-name descname">ENABLED</code><em class="property"> = Status(string='ENABLED')</em><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.Status.ENABLED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The acquisition specification is enabled when the stats data collection is
|
||
going on. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.Status.EXPIRED">
|
||
<code class="sig-name descname">EXPIRED</code><em class="property"> = Status(string='EXPIRED')</em><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.Status.EXPIRED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The acquisition specification is expired when the expiration time is
|
||
exceeded. There is no data collection in that case. <strong>Warning:</strong> This class
|
||
attribute is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.UpdateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">counters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resources</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interval</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">expiration</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">memo_</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.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">AcqSpecs.UpdateSpec</span></code> class contains attributes that can be updated
|
||
in an acquisition specification. <strong>Warning:</strong> This class is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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>counters</strong> (<a class="reference internal" href="#com.vmware.vstats_client.AcqSpecs.CounterSpec" title="com.vmware.vstats_client.AcqSpecs.CounterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcqSpecs.CounterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Designates the counter(s) to be sampled. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
If None, the value is unchanged.</p></li>
|
||
<li><p><strong>resources</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vstats_client.RsrcId" title="com.vmware.vstats_client.RsrcId"><code class="xref py py-class docutils literal notranslate"><span class="pre">RsrcId</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A set of resource identifiers representing a single resource to be
|
||
monitored. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.
|
||
If None, the value is unchanged.</p></li>
|
||
<li><p><strong>interval</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>) – Desired sampling rate in seconds. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
If None, the value is unchanged.</p></li>
|
||
<li><p><strong>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>) – Expiration time for this acquisition specification in Unix UTC
|
||
number of seconds (since epoch). When this attribute is 0, the
|
||
default expiration duration is 100 minutes. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
If None, the value is unchanged.</p></li>
|
||
<li><p><strong>memo</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>) – Consumer provided text about this Acquisition Specification.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.
|
||
If None, the value is unchanged.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.create">
|
||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">acq_spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.create" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a new acquisition specification record. <strong>Warning:</strong> This method
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since
|
||
this can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>acq_spec</strong> (<a class="reference internal" href="#com.vmware.vstats_client.AcqSpecs.CreateSpec" title="com.vmware.vstats_client.AcqSpecs.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcqSpecs.CreateSpec</span></code></a>) – Specification for the acquisition of stats data.</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 acquisition specification.
|
||
The return value will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vstats.model.AcqSpec</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.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if <code class="docutils literal notranslate"><span class="pre">acq_spec</span></code> contain any errors.</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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.delete">
|
||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete an acquisition specification. <strong>Warning:</strong> This method is
|
||
available as Technology Preview. These are early access APIs provided
|
||
to test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Acquisition specification ID.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vstats.model.AcqSpec</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.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if <code class="docutils literal notranslate"><span class="pre">id</span></code> 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.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 acquisition specification could not be located.</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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about a specific acquisition specification.
|
||
<strong>Warning:</strong> This method is available as Technology Preview. These are
|
||
early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Acquisition specification ID.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vstats.model.AcqSpec</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vstats_client.AcqSpecs.Info" title="com.vmware.vstats_client.AcqSpecs.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcqSpecs.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the desired acquisition specification.</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 <code class="docutils literal notranslate"><span class="pre">id</span></code> 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.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>
|
||
acquisition specification could not be located.</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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about all acquisition specifications. <strong>Warning:</strong>
|
||
This method is available as Technology Preview. These are early access
|
||
APIs provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</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.vstats_client.AcqSpecs.FilterSpec" title="com.vmware.vstats_client.AcqSpecs.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcqSpecs.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Criteria for selecting records to return.
|
||
When <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> filtering will be applied to the result.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vstats_client.AcqSpecs.ListResult" title="com.vmware.vstats_client.AcqSpecs.ListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcqSpecs.ListResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of acquisition specification records.</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 any of the specified parameters 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 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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.AcqSpecs.update">
|
||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">acq_spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.AcqSpecs.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update an existing acquisition specification. <strong>Warning:</strong> This method
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since
|
||
this can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</p>
|
||
<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>) – Acquisition specification ID.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vstats.model.AcqSpec</span></code>.</p></li>
|
||
<li><p><strong>acq_spec</strong> (<a class="reference internal" href="#com.vmware.vstats_client.AcqSpecs.UpdateSpec" title="com.vmware.vstats_client.AcqSpecs.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcqSpecs.UpdateSpec</span></code></a>) – Updated acquisition specification.</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.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-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>
|
||
acquisition specification could not be located.</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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.CidMid">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">CidMid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mid</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CidMid" 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">CidMid</span></code> class is used to designate a counter. It contains a counter
|
||
id that identifies the semantical counter. There is optional metadata
|
||
identifier that identifies the particular generation of the counter. When
|
||
counter metadata is not designated vStats will use a default for the
|
||
counter metadata. <strong>Warning:</strong> This class is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>cid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Counter Id. CID is a string with rather strong semantic consistency
|
||
across deployments and versions. If two CIDs are identical it
|
||
implies the corresponding counters are the same. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
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.vstats.model.Counter</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.vstats.model.Counter</span></code>.</p></li>
|
||
<li><p><strong>mid</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>) – MID is a 64-bit integer with strong consistency. Given a particular
|
||
CID=cid, if two MIDs are the same, then the corresponding
|
||
counter-metadata objects are same. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
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.vstats.model.CounterMetadata</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.vstats.model.CounterMetadata</span></code>.
|
||
When this attribute is None vStats will use default for the counter
|
||
metadata as obtained from the provider.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">CounterMetadata</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata" 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">CounterMetadata</span></code> class provides access to the different historical
|
||
editions of counters. As computing platforms evolve over time the
|
||
measurement units for different characteristics of the systems change. As
|
||
such changes occur, counters will receive different editions reflected in a
|
||
new metadata record. For example computer memory had changes from kilobytes
|
||
through megabytes into gigabytes. <strong>Warning:</strong> This class is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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="py class">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.CounterEditionStatus">
|
||
<em class="property">class </em><code class="sig-name descname">CounterEditionStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.CounterEditionStatus" 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>Counter metadata status. <strong>Warning:</strong> This enumeration is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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">CounterEditionStatus</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.CounterEditionStatus.CURRENT">
|
||
<code class="sig-name descname">CURRENT</code><em class="property"> = CounterEditionStatus(string='CURRENT')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.CounterEditionStatus.CURRENT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The counter edition is current. This implies a support commitment.
|
||
<strong>Warning:</strong> This class attribute is available as Technology Preview. These
|
||
are early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.CounterEditionStatus.DEFAULT">
|
||
<code class="sig-name descname">DEFAULT</code><em class="property"> = CounterEditionStatus(string='DEFAULT')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.CounterEditionStatus.DEFAULT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The counter edition is current and is the default. <strong>Warning:</strong> This class
|
||
attribute is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.CounterEditionStatus.DEPRECATED">
|
||
<code class="sig-name descname">DEPRECATED</code><em class="property"> = CounterEditionStatus(string='DEPRECATED')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.CounterEditionStatus.DEPRECATED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The counter edition is deprecated. It will be decommissioned rather soon.
|
||
<strong>Warning:</strong> This class attribute is available as Technology Preview. These
|
||
are early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.CounterEditionStatus.EXPERIMENTAL">
|
||
<code class="sig-name descname">EXPERIMENTAL</code><em class="property"> = CounterEditionStatus(string='EXPERIMENTAL')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.CounterEditionStatus.EXPERIMENTAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The counter edition is experimental. Consumers shouldn’t rely on it for the
|
||
long haul. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.CounterEditionStatus.REMOVED">
|
||
<code class="sig-name descname">REMOVED</code><em class="property"> = CounterEditionStatus(string='REMOVED')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.CounterEditionStatus.REMOVED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The counter edition was removed. <strong>Warning:</strong> This class attribute is
|
||
available as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.FilterSpec">
|
||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.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">CounterMetadata.FilterSpec</span></code> class is used to filter the counter
|
||
metadata list. <strong>Warning:</strong> This class is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>status</strong> (<a class="reference internal" href="#com.vmware.vstats_client.CounterMetadata.CounterEditionStatus" title="com.vmware.vstats_client.CounterMetadata.CounterEditionStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">CounterMetadata.CounterEditionStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Counter edition status. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
When None no filtering on counter metadata status will be made.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">units</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">scale</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user_info</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">pid</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.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">CounterMetadata.Info</span></code> class contains information about
|
||
CounterMetadata. It represents edition of the Counter. <strong>Warning:</strong> This
|
||
class is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</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>cid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Counter Id. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.
|
||
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.vstats.model.Counter</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.vstats.model.Counter</span></code>.</p></li>
|
||
<li><p><strong>mid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Metadata Id. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.
|
||
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.vstats.model.CounterMetadata</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.vstats.model.CounterMetadata</span></code>.</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vstats_client.CounterMetadata.CounterEditionStatus" title="com.vmware.vstats_client.CounterMetadata.CounterEditionStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">CounterMetadata.CounterEditionStatus</span></code></a>) – Counter Edition status. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vstats_client.CounterMetadata.SampleType" title="com.vmware.vstats_client.CounterMetadata.SampleType"><code class="xref py py-class docutils literal notranslate"><span class="pre">CounterMetadata.SampleType</span></code></a>) – Numeric properties of the sampled data. <strong>Warning:</strong> This attribute
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p></li>
|
||
<li><p><strong>units</strong> (<a class="reference internal" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits" title="com.vmware.vstats_client.CounterMetadata.MetricUnits"><code class="xref py py-class docutils literal notranslate"><span class="pre">CounterMetadata.MetricUnits</span></code></a>) – The units of the measurement. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p></li>
|
||
<li><p><strong>scale</strong> (<a class="reference internal" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor" title="com.vmware.vstats_client.CounterMetadata.UnitsFactor"><code class="xref py py-class docutils literal notranslate"><span class="pre">CounterMetadata.UnitsFactor</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Additional multiplier factors to be used with units. <strong>Warning:</strong>
|
||
This attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
When None default of <code class="docutils literal notranslate"><span class="pre">ONE</span></code> is used.</p></li>
|
||
<li><p><strong>user_info</strong> (<a class="reference internal" href="#com.vmware.vstats_client.UserInfo" title="com.vmware.vstats_client.UserInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">UserInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Human legible localizable text about the counter. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
This attribute is None in the current version.</p></li>
|
||
<li><p><strong>pid</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>) – ID of the respective provider. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
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.vstats.model.Provider</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.vstats.model.Provider</span></code>.
|
||
This attribute is None in the current version.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits">
|
||
<em class="property">class </em><code class="sig-name descname">MetricUnits</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits" 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>Unit used by a metric. <strong>Warning:</strong> This enumeration is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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">MetricUnits</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.AMPERE">
|
||
<code class="sig-name descname">AMPERE</code><em class="property"> = MetricUnits(string='AMPERE')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.AMPERE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Ampere. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.BIT">
|
||
<code class="sig-name descname">BIT</code><em class="property"> = MetricUnits(string='BIT')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.BIT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bit. <strong>Warning:</strong> This class attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.BITSPERSECOND">
|
||
<code class="sig-name descname">BITSPERSECOND</code><em class="property"> = MetricUnits(string='BITSPERSECOND')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.BITSPERSECOND" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bits per second. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.BYTE">
|
||
<code class="sig-name descname">BYTE</code><em class="property"> = MetricUnits(string='BYTE')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.BYTE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Byte. <strong>Warning:</strong> This class attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.BYTESPERSECOND">
|
||
<code class="sig-name descname">BYTESPERSECOND</code><em class="property"> = MetricUnits(string='BYTESPERSECOND')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.BYTESPERSECOND" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bytes per second. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.CANDELA">
|
||
<code class="sig-name descname">CANDELA</code><em class="property"> = MetricUnits(string='CANDELA')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.CANDELA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Candela. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.CELSIUS">
|
||
<code class="sig-name descname">CELSIUS</code><em class="property"> = MetricUnits(string='CELSIUS')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.CELSIUS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Celsius. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.GRAM">
|
||
<code class="sig-name descname">GRAM</code><em class="property"> = MetricUnits(string='GRAM')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.GRAM" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gram. <strong>Warning:</strong> This class attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.HERTZ">
|
||
<code class="sig-name descname">HERTZ</code><em class="property"> = MetricUnits(string='HERTZ')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.HERTZ" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hertz. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.JOULE">
|
||
<code class="sig-name descname">JOULE</code><em class="property"> = MetricUnits(string='JOULE')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.JOULE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Joule. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.KELVIN">
|
||
<code class="sig-name descname">KELVIN</code><em class="property"> = MetricUnits(string='KELVIN')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.KELVIN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Kelvin. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.KILOGRAM">
|
||
<code class="sig-name descname">KILOGRAM</code><em class="property"> = MetricUnits(string='KILOGRAM')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.KILOGRAM" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Kilogram. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.METER">
|
||
<code class="sig-name descname">METER</code><em class="property"> = MetricUnits(string='METER')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.METER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Meter. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.METERSPERSECOND">
|
||
<code class="sig-name descname">METERSPERSECOND</code><em class="property"> = MetricUnits(string='METERSPERSECOND')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.METERSPERSECOND" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Meters per second. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.METERSPERSECONDSQUARED">
|
||
<code class="sig-name descname">METERSPERSECONDSQUARED</code><em class="property"> = MetricUnits(string='METERSPERSECONDSQUARED')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.METERSPERSECONDSQUARED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Meters per second squared. <strong>Warning:</strong> This class attribute is available
|
||
as Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change based
|
||
on feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.MOLE">
|
||
<code class="sig-name descname">MOLE</code><em class="property"> = MetricUnits(string='MOLE')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.MOLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mole. <strong>Warning:</strong> This class attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.NUMBER">
|
||
<code class="sig-name descname">NUMBER</code><em class="property"> = MetricUnits(string='NUMBER')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.NUMBER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.PERCENT">
|
||
<code class="sig-name descname">PERCENT</code><em class="property"> = MetricUnits(string='PERCENT')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.PERCENT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Percent. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.SECOND">
|
||
<code class="sig-name descname">SECOND</code><em class="property"> = MetricUnits(string='SECOND')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.SECOND" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Second. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.VOLT">
|
||
<code class="sig-name descname">VOLT</code><em class="property"> = MetricUnits(string='VOLT')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.VOLT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Volt. <strong>Warning:</strong> This class attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.VOLTAMPERE">
|
||
<code class="sig-name descname">VOLTAMPERE</code><em class="property"> = MetricUnits(string='VOLTAMPERE')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.VOLTAMPERE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Volt Ampere. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.MetricUnits.WATT">
|
||
<code class="sig-name descname">WATT</code><em class="property"> = MetricUnits(string='WATT')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.MetricUnits.WATT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Watt. <strong>Warning:</strong> This class attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.SampleType">
|
||
<em class="property">class </em><code class="sig-name descname">SampleType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.SampleType" 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>Type of the sampled data. <strong>Warning:</strong> This enumeration is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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">SampleType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.SampleType.ABSOLUTE">
|
||
<code class="sig-name descname">ABSOLUTE</code><em class="property"> = SampleType(string='ABSOLUTE')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.SampleType.ABSOLUTE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Absolute value samples. Represents an actual value of the counter.
|
||
<strong>Warning:</strong> This class attribute is available as Technology Preview. These
|
||
are early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.SampleType.DELTA">
|
||
<code class="sig-name descname">DELTA</code><em class="property"> = SampleType(string='DELTA')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.SampleType.DELTA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delta samples. Represents an amount of change for the counter between the
|
||
current time-stamp and the last time-stamp when the counter was sampled.
|
||
<strong>Warning:</strong> This class attribute is available as Technology Preview. These
|
||
are early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.SampleType.FRACTION">
|
||
<code class="sig-name descname">FRACTION</code><em class="property"> = SampleType(string='FRACTION')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.SampleType.FRACTION" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Fraction samples. Implies range from 0.00 to 1.00. <strong>Warning:</strong> This class
|
||
attribute is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.SampleType.LOGN">
|
||
<code class="sig-name descname">LOGN</code><em class="property"> = SampleType(string='LOGN')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.SampleType.LOGN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Log(n) samples. A natural logarithm of the value. <strong>Warning:</strong> This class
|
||
attribute is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.SampleType.RATE">
|
||
<code class="sig-name descname">RATE</code><em class="property"> = SampleType(string='RATE')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.SampleType.RATE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Rate samples. Represents a value that has been normalized over the time
|
||
period. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.SampleType.RAW">
|
||
<code class="sig-name descname">RAW</code><em class="property"> = SampleType(string='RAW')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.SampleType.RAW" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Raw samples. The value unprocessed as-is sampled. <strong>Warning:</strong> This class
|
||
attribute is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor">
|
||
<em class="property">class </em><code class="sig-name descname">UnitsFactor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor" 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>Unit factor of measurement. <strong>Warning:</strong> This enumeration is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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">UnitsFactor</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.ATTO">
|
||
<code class="sig-name descname">ATTO</code><em class="property"> = UnitsFactor(string='ATTO')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.ATTO" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Atto 10^-18. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.CENTI">
|
||
<code class="sig-name descname">CENTI</code><em class="property"> = UnitsFactor(string='CENTI')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.CENTI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Centi 10^-2. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.DECA">
|
||
<code class="sig-name descname">DECA</code><em class="property"> = UnitsFactor(string='DECA')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.DECA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deca 10. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.DECI">
|
||
<code class="sig-name descname">DECI</code><em class="property"> = UnitsFactor(string='DECI')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.DECI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deci 10^-1. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.EXA">
|
||
<code class="sig-name descname">EXA</code><em class="property"> = UnitsFactor(string='EXA')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.EXA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Exa 10^18. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.EXBI">
|
||
<code class="sig-name descname">EXBI</code><em class="property"> = UnitsFactor(string='EXBI')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.EXBI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Exbi 2^60, 1024^6. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.FEMTO">
|
||
<code class="sig-name descname">FEMTO</code><em class="property"> = UnitsFactor(string='FEMTO')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.FEMTO" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Femto 10^-15. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.GIBI">
|
||
<code class="sig-name descname">GIBI</code><em class="property"> = UnitsFactor(string='GIBI')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.GIBI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gibi 2^30, 1024^3. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.GIGA">
|
||
<code class="sig-name descname">GIGA</code><em class="property"> = UnitsFactor(string='GIGA')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.GIGA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Giga 10^9. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.HECTO">
|
||
<code class="sig-name descname">HECTO</code><em class="property"> = UnitsFactor(string='HECTO')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.HECTO" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hecto 10^2. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.KIBI">
|
||
<code class="sig-name descname">KIBI</code><em class="property"> = UnitsFactor(string='KIBI')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.KIBI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Kibi 2^10, 1024. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.KILO">
|
||
<code class="sig-name descname">KILO</code><em class="property"> = UnitsFactor(string='KILO')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.KILO" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Kilo 10^3. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.MEBI">
|
||
<code class="sig-name descname">MEBI</code><em class="property"> = UnitsFactor(string='MEBI')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.MEBI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mebi 2^20, 1024^2. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.MEGA">
|
||
<code class="sig-name descname">MEGA</code><em class="property"> = UnitsFactor(string='MEGA')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.MEGA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mega 10^6. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.MICRO">
|
||
<code class="sig-name descname">MICRO</code><em class="property"> = UnitsFactor(string='MICRO')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.MICRO" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Micro 10^-6. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.MILLI">
|
||
<code class="sig-name descname">MILLI</code><em class="property"> = UnitsFactor(string='MILLI')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.MILLI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Milli 10^-3. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.NANO">
|
||
<code class="sig-name descname">NANO</code><em class="property"> = UnitsFactor(string='NANO')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.NANO" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Nano 10^-9. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.ONE">
|
||
<code class="sig-name descname">ONE</code><em class="property"> = UnitsFactor(string='ONE')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.ONE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>One. <strong>Warning:</strong> This class attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.PEBI">
|
||
<code class="sig-name descname">PEBI</code><em class="property"> = UnitsFactor(string='PEBI')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.PEBI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Pebi 2^50, 1024^5. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.PETA">
|
||
<code class="sig-name descname">PETA</code><em class="property"> = UnitsFactor(string='PETA')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.PETA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Peta 10^15. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.PIKO">
|
||
<code class="sig-name descname">PIKO</code><em class="property"> = UnitsFactor(string='PIKO')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.PIKO" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Pico 10^-12. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.TEBI">
|
||
<code class="sig-name descname">TEBI</code><em class="property"> = UnitsFactor(string='TEBI')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.TEBI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Tebi 2^40, 1024^4. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.TERA">
|
||
<code class="sig-name descname">TERA</code><em class="property"> = UnitsFactor(string='TERA')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.TERA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Tera 10^12. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.YOBI">
|
||
<code class="sig-name descname">YOBI</code><em class="property"> = UnitsFactor(string='YOBI')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.YOBI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Yobi 2^80, 1024^8. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.YOCTO">
|
||
<code class="sig-name descname">YOCTO</code><em class="property"> = UnitsFactor(string='YOCTO')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.YOCTO" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Yocto 10^-24. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.YOTTA">
|
||
<code class="sig-name descname">YOTTA</code><em class="property"> = UnitsFactor(string='YOTTA')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.YOTTA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Yotta 10^24. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.ZEBI">
|
||
<code class="sig-name descname">ZEBI</code><em class="property"> = UnitsFactor(string='ZEBI')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.ZEBI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Zebi 2^70, 1024^7. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.ZEPTO">
|
||
<code class="sig-name descname">ZEPTO</code><em class="property"> = UnitsFactor(string='ZEPTO')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.ZEPTO" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Zepto 10^-21. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.UnitsFactor.ZETTA">
|
||
<code class="sig-name descname">ZETTA</code><em class="property"> = UnitsFactor(string='ZETTA')</em><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.UnitsFactor.ZETTA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Zetta 10^21. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cid</span></em>, <em class="sig-param"><span class="n">mid</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about a specific CounterMetadata. <strong>Warning:</strong> This
|
||
method is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since
|
||
this can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Counter ID.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vstats.model.Counter</span></code>.</p></li>
|
||
<li><p><strong>mid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – CounterMetadata ID.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vstats.model.CounterMetadata</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vstats_client.CounterMetadata.Info" title="com.vmware.vstats_client.CounterMetadata.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">CounterMetadata.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the desired CounterMetadata.</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 any of the specified parameters 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.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 Counter or CounterMetadata could not be located.</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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.get_default">
|
||
<code class="sig-name descname">get_default</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cid</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.get_default" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This method returns the “default” CounterMetadata. A Counter has at
|
||
least one related metadata object. Usually, stats providers (for
|
||
example hosts) are in agreement about the default metadata. In this
|
||
case the returned list has a single metadata object.</p>
|
||
<p>Sometimes, when providers are in “disagreement” about the default, then
|
||
the returned list would include all the possible “defaults”. This
|
||
potential ambiguity isn’t a real issue because consumers of the vStats
|
||
API rarely need to specify the “mid” of metadata. Therefore, this API
|
||
is used primarily for informational purposes.. <strong>Warning:</strong> This method
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since
|
||
this can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>cid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Counter ID.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vstats.model.Counter</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vstats_client.CounterMetadata.list" title="com.vmware.vstats_client.CounterMetadata.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.vstats_client.CounterMetadata.Info" title="com.vmware.vstats_client.CounterMetadata.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">CounterMetadata.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of counter metadata records.</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 <code class="docutils literal notranslate"><span class="pre">cid</span></code> 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.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 Counter could not be located.</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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.CounterMetadata.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cid</span></em>, <em class="sig-param"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterMetadata.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about all counter metadata records for a specific
|
||
Counter. <strong>Warning:</strong> This method is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview
|
||
APIs might only be applicable to specific environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Counter ID.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vstats.model.Counter</span></code>.</p></li>
|
||
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vstats_client.CounterMetadata.FilterSpec" title="com.vmware.vstats_client.CounterMetadata.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CounterMetadata.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Filter specification.
|
||
When None no filtering will be performed.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vstats_client.CounterMetadata.list" title="com.vmware.vstats_client.CounterMetadata.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.vstats_client.CounterMetadata.Info" title="com.vmware.vstats_client.CounterMetadata.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">CounterMetadata.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of counter metadata for the specified counter.</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 any of the specified parameters 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.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 Counter could not be located.</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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.CounterSets">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">CounterSets</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterSets" 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">CounterSets</span></code> class provides methods for accessing groupings of
|
||
counters. Counter-sets allow consumers to use groups of counters. The
|
||
counters may relate to different resource types. When an <a class="reference internal" href="#com.vmware.vstats_client.AcqSpecs" title="com.vmware.vstats_client.AcqSpecs"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcqSpecs</span></code></a>
|
||
record refers to a counter-set, only the relevant counters apply.
|
||
<strong>Warning:</strong> This class is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</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="py class">
|
||
<dt id="com.vmware.vstats_client.CounterSets.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">counters</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user_info</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterSets.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">CounterSets.Info</span></code> class contains information about a set of
|
||
counters. <strong>Warning:</strong> This class is available as Technology Preview. These
|
||
are early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>) – Counter set identifier. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
<li><p><strong>counters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vstats_client.CidMid" title="com.vmware.vstats_client.CidMid"><code class="xref py py-class docutils literal notranslate"><span class="pre">CidMid</span></code></a>) – List of Counter CidMids. <strong>Warning:</strong> This attribute is available
|
||
as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
<li><p><strong>user_info</strong> (<a class="reference internal" href="#com.vmware.vstats_client.UserInfo" title="com.vmware.vstats_client.UserInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">UserInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Human legible localizable conter set description. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
In future versions it may be possible to have custom counter sets
|
||
that lack localizable descriptions.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.CounterSets.RESOURCE_TYPE">
|
||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vstats.model.CounterSet'</em><a class="headerlink" href="#com.vmware.vstats_client.CounterSets.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for counter sets. <strong>Warning:</strong> This class attribute is available
|
||
as Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.CounterSets.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">counter_set</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterSets.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about a specific counter set. <strong>Warning:</strong> This
|
||
method is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since
|
||
this can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>counter_set</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the counter set to retrieve.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vstats.model.CounterSet</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vstats_client.CounterSets.Info" title="com.vmware.vstats_client.CounterSets.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">CounterSets.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the desired CounterSet.</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 <code class="docutils literal notranslate"><span class="pre">counter_set</span></code> 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.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 requested counter set could not be located.</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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.CounterSets.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.CounterSets.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about all the counter sets. <strong>Warning:</strong> This
|
||
method is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since
|
||
this can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</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.vstats_client.CounterSets.list" title="com.vmware.vstats_client.CounterSets.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.vstats_client.CounterSets.Info" title="com.vmware.vstats_client.CounterSets.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">CounterSets.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>List of counter sets.</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.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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.Counters">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">Counters</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Counters" 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">Counters</span></code> class provides methods to perform various Counter related
|
||
operations. Counter is derived from metric. It applies the metric to a
|
||
particular class of a resource. <strong>Warning:</strong> This class is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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="py class">
|
||
<dt id="com.vmware.vstats_client.Counters.FilterSpec">
|
||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">types</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metric</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Counters.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">Counters.FilterSpec</span></code> class contains fields that can be used to
|
||
filter list of counters. <strong>Warning:</strong> This class is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>cid</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>) – Counter identifier that will be listed. <strong>Warning:</strong> This attribute
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
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.vstats.model.Counter</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.vstats.model.Counter</span></code>.
|
||
If None counter filter will not be applied.</p></li>
|
||
<li><p><strong>types</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>) – Resource type filter. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
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.vstats.model.RsrcType</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.vstats.model.RsrcType</span></code>.
|
||
If None resource type filter will not be applied.</p></li>
|
||
<li><p><strong>metric</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>) – Metric for which counters will be listed. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
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.vstats.model.Metric</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.vstats.model.Metric</span></code>.
|
||
If None metric filter will not be applied.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.Counters.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metric</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_address_schema</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Counters.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">Counters.Info</span></code> class contains the counter information. Counter is
|
||
derived from metric. It applies the metric to a particular class of a
|
||
resource. <strong>Warning:</strong> This class is available as Technology Preview. These
|
||
are early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>cid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Counter Id. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.
|
||
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.vstats.model.Counter</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.vstats.model.Counter</span></code>.</p></li>
|
||
<li><p><strong>metric</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A metric is typically human-legible ASCII/English name of a
|
||
measurable aspect, for example “length” and “temperature”. It is
|
||
not internationalizable. <strong>Warning:</strong> This attribute is available
|
||
as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
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.vstats.model.Metric</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.vstats.model.Metric</span></code>.</p></li>
|
||
<li><p><strong>resource_address_schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Describes formally how to address (or identify) the resources the
|
||
counter could be bound to (or instantiated for). <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
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.vstats.model.RsrcAddrSchema</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.vstats.model.RsrcAddrSchema</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.Counters.RESOURCE_TYPE">
|
||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vstats.model.Counter'</em><a class="headerlink" href="#com.vmware.vstats_client.Counters.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for counters. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.Counters.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cid</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Counters.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about a specific Counter. <strong>Warning:</strong> This method
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since
|
||
this can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>cid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Counter ID.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vstats.model.Counter</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vstats_client.Counters.Info" title="com.vmware.vstats_client.Counters.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Counters.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the requested counter.</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 <code class="docutils literal notranslate"><span class="pre">cid</span></code> 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.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 Counter could not be located.</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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.Counters.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Counters.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about all counters matching the filter parameters.
|
||
<strong>Warning:</strong> This method is available as Technology Preview. These are
|
||
early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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.vstats_client.Counters.FilterSpec" title="com.vmware.vstats_client.Counters.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Counters.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Filters the returned records.
|
||
When None no filtering will be applied.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vstats_client.Counters.list" title="com.vmware.vstats_client.Counters.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.vstats_client.Counters.Info" title="com.vmware.vstats_client.Counters.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Counters.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of Counters.</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 any of the specified parameters 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 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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.Data">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">Data</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Data" 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">Data</span></code> class provides methods to query measurement and statistic
|
||
data. <strong>Warning:</strong> This class is available as Technology Preview. These are
|
||
early access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</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="py class">
|
||
<dt id="com.vmware.vstats_client.Data.DataPoint">
|
||
<em class="property">class </em><code class="sig-name descname">DataPoint</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">rid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">val</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Data.DataPoint" 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">Data.DataPoint</span></code> class is an instance of a measurement or stat. A
|
||
data point is comprised of a Counter, CounterMetadata, Resource, timestamp
|
||
and value. <strong>Warning:</strong> This class is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>cid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Counter Id. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.
|
||
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.vstats.model.Counter</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.vstats.model.Counter</span></code>.</p></li>
|
||
<li><p><strong>mid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – CounterMetadata Id. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
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.vstats.model.CounterMetadata</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.vstats.model.CounterMetadata</span></code>.</p></li>
|
||
<li><p><strong>rid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Resource Id. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.</p></li>
|
||
<li><p><strong>ts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Timestamp for the data point. format: 64-bit integer. <strong>Warning:</strong>
|
||
This attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.</p></li>
|
||
<li><p><strong>val</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – Stat value. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.Data.DataPointsResult">
|
||
<em class="property">class </em><code class="sig-name descname">DataPointsResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data_points</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">next</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Data.DataPointsResult" 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">Data.DataPointsResult</span></code> class contains attributes used to return
|
||
DataPoints. <strong>Warning:</strong> This class is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>data_points</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vstats_client.Data.DataPoint" title="com.vmware.vstats_client.Data.DataPoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data.DataPoint</span></code></a>) – List of DataPoints received. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p></li>
|
||
<li><p><strong>next</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 <code class="docutils literal notranslate"><span class="pre">next</span></code> attribute is a token used to retrieve paged data for
|
||
larger result sets. This is opaque token generated by the server.
|
||
It is to be sent in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Data.FilterSpec.page</span></code> attribute to
|
||
issue a subsequent call to the query method for retrieving results
|
||
that did not fit the current page. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> when there are more results to retrieve.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.Data.FilterSpec">
|
||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">start</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metric</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">types</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resources</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">order</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Data.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">Data.FilterSpec</span></code> class contains attributes used to filter the
|
||
results when listing DataPoint. <strong>Warning:</strong> This class is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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>start</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>) – Start of a time window (included), timestamp in seconds UTC.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.
|
||
When None the result will not be limited by start time.</p></li>
|
||
<li><p><strong>end</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>) – End of a time window (excluded), timestamp in seconds UTC.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.
|
||
When None the result will not be limited by end time.</p></li>
|
||
<li><p><strong>cid</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>) – Counter ID. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.
|
||
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.vstats.model.Counter</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.vstats.model.Counter</span></code>.
|
||
When None the result will not be filtered by counter.</p></li>
|
||
<li><p><strong>metric</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>) – Metric name. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.
|
||
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.vstats.model.Metric</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.vstats.model.Metric</span></code>.
|
||
When None the result will not be filtered by metric name.</p></li>
|
||
<li><p><strong>types</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>) – List of Resource types. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
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.vstats.model.RsrcType</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.vstats.model.RsrcType</span></code>.
|
||
When None the result will not be filtered by resource types.</p></li>
|
||
<li><p><strong>resources</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>) – <p>Resources to include in the query. Each resource is specified
|
||
through a composite string that follows the following format.</p>
|
||
<blockquote>
|
||
<div><p><code class="docutils literal notranslate"><span class="pre">type.<resource</span> <span class="pre">type>[.<scheme>]=<resource</span> <span class="pre">id></span></code></p>
|
||
</div></blockquote>
|
||
<p><strong>resource type</strong> specifies the type of resource for example
|
||
<code class="docutils literal notranslate"><span class="pre">VM</span></code>, <code class="docutils literal notranslate"><span class="pre">VCPU</span></code> etc.</p>
|
||
<p><strong>scheme</strong> is an optional element to disambiguate the resource as
|
||
needed for example to differentiate managed object id from
|
||
<code class="docutils literal notranslate"><span class="pre">uuid</span></code>.</p>
|
||
<p><strong>resource id</strong> is the unique resource identifier value for
|
||
example: <code class="docutils literal notranslate"><span class="pre">vm-41</span></code></p>
|
||
<p>Example values include: <code class="docutils literal notranslate"><span class="pre">type.VM=vm-41</span></code>, <code class="docutils literal notranslate"><span class="pre">type.VCPU=1</span></code>,
|
||
<code class="docutils literal notranslate"><span class="pre">type.VM.moid=vm-41</span></code>. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
When left None the result will not be filtered for specific
|
||
resources.</p>
|
||
</p></li>
|
||
<li><p><strong>order</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>) – Directs the server to order the returned data. Passing a value of
|
||
<code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code> will apply default ordering of the results that makes
|
||
them easier for consumption. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
When this parameter is None the server will not order the result,
|
||
save computational time and therefore the API will operate faster.</p></li>
|
||
<li><p><strong>page</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>) – Used to retrieve paged data for larger result sets. The value of
|
||
this token is generated by server and returned as <code class="docutils literal notranslate"><span class="pre">next</span></code>
|
||
attribute in the result of <code class="docutils literal notranslate"><span class="pre">queryDataPoints</span></code> methods.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.
|
||
When None the first page of results will be returned.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.Data.query_data_points">
|
||
<code class="sig-name descname">query_data_points</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Data.query_data_points" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns <a class="reference internal" href="#com.vmware.vstats_client.Data.DataPointsResult" title="com.vmware.vstats_client.Data.DataPointsResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data.DataPointsResult</span></code></a> matching the filter parameters.</p>
|
||
<blockquote>
|
||
<div><p><code class="docutils literal notranslate"><span class="pre">/vstats/data/dp?types=VM&types=VCPU</span></code></p>
|
||
</div></blockquote>
|
||
<p><code class="docutils literal notranslate"><span class="pre">/vstats/data/dp?rsrcs=type.HOST=host-16&rsrcs=type.VM=vm-31</span></code>.
|
||
<strong>Warning:</strong> This method is available as Technology Preview. These are
|
||
early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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.vstats_client.Data.FilterSpec" title="com.vmware.vstats_client.Data.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification to match DataPoints.
|
||
When <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> filtering will be applied to the result.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vstats_client.Data.DataPointsResult" title="com.vmware.vstats_client.Data.DataPointsResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data.DataPointsResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Data points matching the filter.</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 any of the specified parameters 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 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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.Metrics">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">Metrics</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Metrics" 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">Metrics</span></code> class provides method to list metrics. A metric is a
|
||
fundamental concept. It means a measurable aspect or property. For
|
||
instance, temperature, count, velocity, data size, bandwidth. <strong>Warning:</strong>
|
||
This class is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</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="py attribute">
|
||
<dt id="com.vmware.vstats_client.Metrics.RESOURCE_TYPE">
|
||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vstats.model.Metric'</em><a class="headerlink" href="#com.vmware.vstats_client.Metrics.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for metrics. <strong>Warning:</strong> This class attribute is available as
|
||
Technology Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.Metrics.Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">metric</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Metrics.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">Metrics.Summary</span></code> class contains metric summary. <strong>Warning:</strong> This
|
||
class is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</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>metric</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Metric name. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.
|
||
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.vstats.model.Metric</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.vstats.model.Metric</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.Metrics.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Metrics.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns list of available Metrics as supplied by the discovered
|
||
providers. <strong>Warning:</strong> This method is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview
|
||
APIs might only be applicable to specific environments.</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.vstats_client.Metrics.list" title="com.vmware.vstats_client.Metrics.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.vstats_client.Metrics.Summary" title="com.vmware.vstats_client.Metrics.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Metrics.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>List of Metrics.</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.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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.Providers">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">Providers</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Providers" 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">Providers</span></code> class manages list of statistical data provider services
|
||
that are currently used. <strong>Warning:</strong> This class is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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="py attribute">
|
||
<dt id="com.vmware.vstats_client.Providers.RESOURCE_TYPE">
|
||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vstats.model.Provider'</em><a class="headerlink" href="#com.vmware.vstats_client.Providers.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for data providers. <strong>Warning:</strong> This class attribute is
|
||
available as Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.Providers.Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">scheme</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metadata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tracking_sn</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Providers.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><code class="docutils literal notranslate"><span class="pre">Providers.Summary</span></code> class describes a statistical data provider.
|
||
<strong>Warning:</strong> This class is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</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>) – Provider identifier. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
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.vstats.model.Provider</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.vstats.model.Provider</span></code>.</p></li>
|
||
<li><p><strong>id_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID given to the provider by its respective inventory.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Provider type. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
<li><p><strong>scheme</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>) – An optional designation of the scheme. <strong>Warning:</strong> This attribute
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
When None the provider is not designating a specific scheme.</p></li>
|
||
<li><p><strong>metadata</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>) – Schema-less metadata with extra information for the provider.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.
|
||
As supplied by the provider.</p></li>
|
||
<li><p><strong>tracking_sn</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>) – Timestamp which is obtained when querying counters from a provider
|
||
and is used as since parameter when new counter listing is needed.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.
|
||
{term unset} if no timestamp has been obtained yet.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.Providers.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.Providers.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a list of stats providers. <strong>Warning:</strong> This method is
|
||
available as Technology Preview. These are early access APIs provided
|
||
to test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</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.vstats_client.Providers.list" title="com.vmware.vstats_client.Providers.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.vstats_client.Providers.Summary" title="com.vmware.vstats_client.Providers.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>List of stats providers.</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.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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.QueryPredicate">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">QueryPredicate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.QueryPredicate" 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">QueryPredicate</span></code> enum describes how to query an id present in a
|
||
<code class="docutils literal notranslate"><span class="pre">RsrcId</span></code>. <strong>Warning:</strong> This enumeration is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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 <a class="reference internal" href="#com.vmware.vstats_client.QueryPredicate" title="com.vmware.vstats_client.QueryPredicate"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryPredicate</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.QueryPredicate.ALL">
|
||
<code class="sig-name descname">ALL</code><em class="property"> = QueryPredicate(string='ALL')</em><a class="headerlink" href="#com.vmware.vstats_client.QueryPredicate.ALL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Matching all available id-s. <strong>Warning:</strong> This class attribute is available
|
||
as Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change based
|
||
on feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.QueryPredicate.EQUAL">
|
||
<code class="sig-name descname">EQUAL</code><em class="property"> = QueryPredicate(string='EQUAL')</em><a class="headerlink" href="#com.vmware.vstats_client.QueryPredicate.EQUAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Matching id-s by equality. <strong>Warning:</strong> This class attribute is available
|
||
as Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change based
|
||
on feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.ResourceAddressSchemas">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">ResourceAddressSchemas</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddressSchemas" 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">ResourceAddressSchemas</span></code> class manages inventory of resource
|
||
addressing schemas used by <a class="reference internal" href="#com.vmware.vstats_client.Counters" title="com.vmware.vstats_client.Counters"><code class="xref py py-class docutils literal notranslate"><span class="pre">Counters</span></code></a>. Each schema consists of a
|
||
named list of resource identifiers of specific resource type. <strong>Warning:</strong>
|
||
This class is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</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="py class">
|
||
<dt id="com.vmware.vstats_client.ResourceAddressSchemas.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddressSchemas.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">ResourceAddressSchemas.Info</span></code> class defines addressing schema for a
|
||
counter. This is set of named placeholders for different resource types.
|
||
For example a network link between VMs will take two arguments “source” and
|
||
“destination” both of type VM. For each argument query capability is
|
||
defined. <strong>Warning:</strong> This class is available as Technology Preview. These
|
||
are early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>) – Identifier. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.
|
||
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.vstats.model.RsrcAddrSchema</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.vstats.model.RsrcAddrSchema</span></code>.</p></li>
|
||
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vstats_client.ResourceAddressSchemas.ResourceIdDefinition" title="com.vmware.vstats_client.ResourceAddressSchemas.ResourceIdDefinition"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAddressSchemas.ResourceIdDefinition</span></code></a>) – List of :class:<a href="#id1"><span class="problematic" id="id2">`</span></a>ResourceAddressSchemas.ResourceIdDefinition`s.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.ResourceAddressSchemas.QueryCapabilities">
|
||
<em class="property">class </em><code class="sig-name descname">QueryCapabilities</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddressSchemas.QueryCapabilities" 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>Declares which predicates are supported by the
|
||
<code class="docutils literal notranslate"><span class="pre">ResourceAddressSchemas.ResourceIdDefinition</span></code>. <strong>Warning:</strong> This
|
||
enumeration is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</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">QueryCapabilities</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.ResourceAddressSchemas.QueryCapabilities.EQUAL">
|
||
<code class="sig-name descname">EQUAL</code><em class="property"> = QueryCapabilities(string='EQUAL')</em><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddressSchemas.QueryCapabilities.EQUAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Equal. <strong>Warning:</strong> This class attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.ResourceAddressSchemas.QueryCapabilities.EQUAL_ALL">
|
||
<code class="sig-name descname">EQUAL_ALL</code><em class="property"> = QueryCapabilities(string='EQUAL_ALL')</em><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddressSchemas.QueryCapabilities.EQUAL_ALL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Supports both Equality and Aggregation. <strong>Warning:</strong> This class attribute
|
||
is available as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.ResourceAddressSchemas.RESOURCE_TYPE">
|
||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vstats.model.RsrcAddrSchema'</em><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddressSchemas.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for resource addressing schemas. <strong>Warning:</strong> This class
|
||
attribute is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.ResourceAddressSchemas.ResourceIdDefinition">
|
||
<em class="property">class </em><code class="sig-name descname">ResourceIdDefinition</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">query_options</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddressSchemas.ResourceIdDefinition" 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">ResourceAddressSchemas.ResourceIdDefinition</span></code> class describes a
|
||
single identifier of the Resource Addressing Schema. <strong>Warning:</strong> This
|
||
class is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</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>key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Designates a semantic key for the resource identifier. This could
|
||
be “vm” for virtual machine whose CPU usage is metered or “source”
|
||
to identify the virtual machine that is origin of measured network
|
||
traffic. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Type of the resource. This represents various entities for which
|
||
statistical data is gathered such as virtual machines, containers,
|
||
servers, disks etc. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
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.vstats.model.RsrcType</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.vstats.model.RsrcType</span></code>.</p></li>
|
||
<li><p><strong>query_options</strong> (<a class="reference internal" href="#com.vmware.vstats_client.ResourceAddressSchemas.QueryCapabilities" title="com.vmware.vstats_client.ResourceAddressSchemas.QueryCapabilities"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAddressSchemas.QueryCapabilities</span></code></a>) – Designates the supported query-options. <strong>Warning:</strong> This attribute
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.ResourceAddressSchemas.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddressSchemas.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about a specific resource address schema.
|
||
<strong>Warning:</strong> This method is available as Technology Preview. These are
|
||
early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Resource address schema identifier.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vstats_client.ResourceAddressSchemas.Info" title="com.vmware.vstats_client.ResourceAddressSchemas.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAddressSchemas.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the desired resource address schema.</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 <code class="docutils literal notranslate"><span class="pre">id</span></code> 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.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 RsrcAddrSchema could not be located.</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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.ResourceAddresses">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">ResourceAddresses</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddresses" 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">ResourceAddresses</span></code> class provides methods to perform resource
|
||
addressing queries. <strong>Warning:</strong> This class is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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="py class">
|
||
<dt id="com.vmware.vstats_client.ResourceAddresses.FilterSpec">
|
||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">types</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resources</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddresses.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><code class="docutils literal notranslate"><span class="pre">ResourceAddresses.FilterSpec</span></code> class describes filter criteria for
|
||
resource addresses. <strong>Warning:</strong> This class is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>types</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>) – List of Resource types. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
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.vstats.model.RsrcType</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.vstats.model.RsrcType</span></code>.
|
||
When None the result will not be filtered by resource types.</p></li>
|
||
<li><p><strong>resources</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>) – <p>Resources to include in the query. Each resource is specified
|
||
through a composite string that follows the following format.</p>
|
||
<blockquote>
|
||
<div><p><code class="docutils literal notranslate"><span class="pre">type.<resource</span> <span class="pre">type>[.<scheme>]=<resource</span> <span class="pre">id></span></code></p>
|
||
</div></blockquote>
|
||
<p><strong>resource type</strong> specifies the type of resource for example
|
||
<code class="docutils literal notranslate"><span class="pre">VM</span></code>, <code class="docutils literal notranslate"><span class="pre">VCPU</span></code> etc.</p>
|
||
<p><strong>scheme</strong> is an optional element to disambiguate the resource as
|
||
needed for example to differentiate managed object id from
|
||
<code class="docutils literal notranslate"><span class="pre">uuid</span></code>.</p>
|
||
<p><strong>resource id</strong> is the unique resource identifier value for
|
||
example: <code class="docutils literal notranslate"><span class="pre">vm-41</span></code></p>
|
||
<p>Example values include: <code class="docutils literal notranslate"><span class="pre">type.VM=vm-41</span></code>, <code class="docutils literal notranslate"><span class="pre">type.VCPU=1</span></code>,
|
||
<code class="docutils literal notranslate"><span class="pre">type.VM.moid=vm-41</span></code>. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
When left None the result will not be filtered for specific
|
||
resources.</p>
|
||
</p></li>
|
||
<li><p><strong>page</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 <code class="docutils literal notranslate"><span class="pre">page</span></code> field is used to retrieve paged data for large result
|
||
sets. It is an opaque paging token obtained from a prior call to
|
||
the <a class="reference internal" href="#com.vmware.vstats_client.ResourceAddresses.list" title="com.vmware.vstats_client.ResourceAddresses.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResourceAddresses.list()</span></code></a> API. <strong>Warning:</strong> This attribute
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
when <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> a follow up page in a paged result set will be
|
||
delivered.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.ResourceAddresses.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_ids</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddresses.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">ResourceAddresses.Info</span></code> class contains global address of a specific
|
||
Resource. <strong>Warning:</strong> This class is available as Technology Preview. These
|
||
are early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>) – Identifier. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.
|
||
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.vstats.model.RsrcAddr</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.vstats.model.RsrcAddr</span></code>.</p></li>
|
||
<li><p><strong>resource_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vstats_client.RsrcId" title="com.vmware.vstats_client.RsrcId"><code class="xref py py-class docutils literal notranslate"><span class="pre">RsrcId</span></code></a>) – List of Resource Identifiers. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.ResourceAddresses.ListResult">
|
||
<em class="property">class </em><code class="sig-name descname">ListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">rsrc_addrs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">next</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddresses.ListResult" 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.vstats_client.ResourceAddresses.ListResult" title="com.vmware.vstats_client.ResourceAddresses.ListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAddresses.ListResult</span></code></a> class contains attributes used to
|
||
return the resource addresses. <strong>Warning:</strong> This class is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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>rsrc_addrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vstats_client.ResourceAddresses.Info" title="com.vmware.vstats_client.ResourceAddresses.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAddresses.Info</span></code></a>) – List of Resource Addresses received. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p></li>
|
||
<li><p><strong>next</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>) – Used to retrieve paged data for larger result sets. Token is
|
||
generated by server. The value of this field should be supplied in
|
||
a subsequent call to <a class="reference internal" href="#com.vmware.vstats_client.ResourceAddresses.list" title="com.vmware.vstats_client.ResourceAddresses.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">ResourceAddresses.list()</span></code></a> method.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.
|
||
None when there are no more pages of data to be retrieved.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vstats_client.ResourceAddresses.RESOURCE_TYPE">
|
||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vstats.model.RsrcAddr'</em><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddresses.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for <code class="docutils literal notranslate"><span class="pre">ResourceAddresses</span></code>. <strong>Warning:</strong> This class attribute is
|
||
available as Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.ResourceAddresses.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddresses.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about a specific Resource Address. <strong>Warning:</strong>
|
||
This method is available as Technology Preview. These are early access
|
||
APIs provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Resource Address ID.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vstats.model.RsrcAddr</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vstats_client.ResourceAddresses.Info" title="com.vmware.vstats_client.ResourceAddresses.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAddresses.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the desired Resource Address.</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 <code class="docutils literal notranslate"><span class="pre">id</span></code> 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.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 Resource Address could not be located.</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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.ResourceAddresses.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceAddresses.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the list of Resource Addresses matching the filter parameters.
|
||
<strong>Warning:</strong> This method is available as Technology Preview. These are
|
||
early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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.vstats_client.ResourceAddresses.FilterSpec" title="com.vmware.vstats_client.ResourceAddresses.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAddresses.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Criteria for selecting records to return.
|
||
If None all records will be returned.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vstats_client.ResourceAddresses.ListResult" title="com.vmware.vstats_client.ResourceAddresses.ListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAddresses.ListResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Matching resource addresses.</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 any of the specified parameters 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 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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.ResourceTypes">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">ResourceTypes</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceTypes" 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">ResourceTypes</span></code> class provides list of resource types. Resource
|
||
refers to any item or concept that could have measurable properties. It is
|
||
a prerequisite that a resource can be identified.</p>
|
||
<p>Example resource types are virtual machine, virtual disk etc.. <strong>Warning:</strong>
|
||
This class is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</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="py attribute">
|
||
<dt id="com.vmware.vstats_client.ResourceTypes.RESOURCE_TYPE">
|
||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vstats.model.RsrcType'</em><a class="headerlink" href="#com.vmware.vstats_client.ResourceTypes.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for resource types. <strong>Warning:</strong> This class attribute is
|
||
available as Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.ResourceTypes.Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceTypes.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">ResourceTypes.Summary</span></code> class contains information of addressable
|
||
resource. <strong>Warning:</strong> This class is available as Technology Preview. These
|
||
are early access APIs provided to test, automate and provide feedback on
|
||
the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Resource type. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
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.vstats.model.RsrcType</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.vstats.model.RsrcType</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vstats_client.ResourceTypes.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.ResourceTypes.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a list of available resource types. <strong>Warning:</strong> This method is
|
||
available as Technology Preview. These are early access APIs provided
|
||
to test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</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.vstats_client.ResourceTypes.list" title="com.vmware.vstats_client.ResourceTypes.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.vstats_client.ResourceTypes.Summary" title="com.vmware.vstats_client.ResourceTypes.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceTypes.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>List of resource types.</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.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 does not have sufficient privileges.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.RsrcId">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">RsrcId</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">predicate</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">scheme</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.RsrcId" 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">RsrcId</span></code> class specifies identification of a resource to be monitored
|
||
by an acquisition specification record. <strong>Warning:</strong> This class is
|
||
available as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</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>key</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>) – Key relates to the corresponding ResourceIdDefinition of the
|
||
related resource address schema. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
When this attribute is None, type attribute will be used.</p></li>
|
||
<li><p><strong>type</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>) – Type of the resource identified by the Resource Id. <strong>Warning:</strong>
|
||
This attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
When this attribute is None, in current version the api will throw
|
||
InvalidArgument error. To be made optional in future.</p></li>
|
||
<li><p><strong>id_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The id value binding the related resource id definition.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</p></li>
|
||
<li><p><strong>predicate</strong> (<a class="reference internal" href="#com.vmware.vstats_client.QueryPredicate" title="com.vmware.vstats_client.QueryPredicate"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryPredicate</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Predicate to use to match resource Ids. <strong>Warning:</strong> This attribute
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
When this attribute is None, default predicate is EQUAL.</p></li>
|
||
<li><p><strong>scheme</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>) – An optional designation of the scheme. <strong>Warning:</strong> This attribute
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
When this attribute is None, default scheme is moid (ManagedObject
|
||
Identifier).</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vstats_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_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="py class">
|
||
<dt id="com.vmware.vstats_client.UserInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vstats_client.</code><code class="sig-name descname">UserInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vstats_client.UserInfo" 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">UserInfo</span></code> class contains human legible, localizable description,
|
||
used for VMware provided objects. <strong>Warning:</strong> This class is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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>label</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>) – Short label. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.</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>) – Detailed description of the object. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p></li>
|
||
</ul>
|
||
</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 2020, VMware, Inc.
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||
|
||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |