mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-26 19:29:58 -05:00
4810 lines
366 KiB
HTML
4810 lines
366 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|||
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
|
|||
|
|
<title>com.vmware package — vSphere Automation SDK for Python 6.7.0 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="index" title="Index"
|
|||
|
|
href="genindex.html"/>
|
|||
|
|
<link rel="search" title="Search" href="search.html"/>
|
|||
|
|
<link rel="top" title="vSphere Automation SDK for Python 6.7.0 documentation" href="index.html"/>
|
|||
|
|
<link rel="up" title="com package" href="com.html"/>
|
|||
|
|
<link rel="next" title="com.vmware.appliance package" href="com.vmware.appliance.html"/>
|
|||
|
|
<link rel="prev" title="com package" href="com.html"/>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script src="_static/js/modernizr.min.js"></script>
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav" role="document">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
6.7.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.vcenter_client">com.vmware.vcenter_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">vSphere Automation SDK for Python</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
<div class="rst-content">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|||
|
|
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li><a href="index.html">Docs</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>com.vmware package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.rst.txt" rel="nofollow"> View page source</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<div class="section" id="module-com.vmware">
|
|||
|
|
<span id="com-vmware-package"></span><h1>com.vmware package<a class="headerlink" href="#module-com.vmware" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<div class="section" id="subpackages">
|
|||
|
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<div class="toctree-wrapper compound">
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.appliance.html">com.vmware.appliance package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.appliance.networking.html">com.vmware.appliance.networking package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.networking.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.dns_client">com.vmware.appliance.networking.dns_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.interfaces_client">com.vmware.appliance.networking.interfaces_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.appliance.recovery.html">com.vmware.appliance.recovery package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.recovery.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html">com.vmware.appliance.recovery.backup package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup.job_client">com.vmware.appliance.recovery.backup.job_client module</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup.system_name_client">com.vmware.appliance.recovery.backup.system_name_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.recovery.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.backup_client">com.vmware.appliance.recovery.backup_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.reconciliation_client">com.vmware.appliance.recovery.reconciliation_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.restore_client">com.vmware.appliance.recovery.restore_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.appliance.system.html">com.vmware.appliance.system package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.system.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.system.html#module-com.vmware.appliance.system.time_client">com.vmware.appliance.system.time_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.access_client">com.vmware.appliance.access_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.health_client">com.vmware.appliance.health_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.local_accounts_client">com.vmware.appliance.local_accounts_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.localaccounts_client">com.vmware.appliance.localaccounts_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.logging_client">com.vmware.appliance.logging_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.monitoring_client">com.vmware.appliance.monitoring_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.networking_client">com.vmware.appliance.networking_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.ntp_client">com.vmware.appliance.ntp_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.recovery_client">com.vmware.appliance.recovery_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.shutdown_client">com.vmware.appliance.shutdown_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.system_client">com.vmware.appliance.system_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.tymesync_client">com.vmware.appliance.tymesync_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.update_client">com.vmware.appliance.update_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.html#module-com.vmware.appliance.vmon_client">com.vmware.appliance.vmon_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.cis.html">com.vmware.cis package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.cis.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.cis.html#module-com.vmware.cis.tagging_client">com.vmware.cis.tagging_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.cis.html#module-com.vmware.cis.task_client">com.vmware.cis.task_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.content.html">com.vmware.content package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.content.library.html">com.vmware.content.library package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.library.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.content.library.item.html">com.vmware.content.library.item package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.library.item.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.downloadsession_client">com.vmware.content.library.item.downloadsession_client module</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.updatesession_client">com.vmware.content.library.item.updatesession_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.library.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.library.html#module-com.vmware.content.library.item_client">com.vmware.content.library.item_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.html#module-com.vmware.content.library_client">com.vmware.content.library_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vapi.html">com.vmware.vapi package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.metadata.html">com.vmware.vapi.metadata package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html">com.vmware.vapi.metadata.authentication package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#module-com.vmware.vapi.metadata.authentication.service_client">com.vmware.vapi.metadata.authentication.service_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html">com.vmware.vapi.metadata.metamodel package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.resource_client">com.vmware.vapi.metadata.metamodel.resource_client module</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.service_client">com.vmware.vapi.metadata.metamodel.service_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html">com.vmware.vapi.metadata.privilege package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#module-com.vmware.vapi.metadata.privilege.service_client">com.vmware.vapi.metadata.privilege.service_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.authentication_client">com.vmware.vapi.metadata.authentication_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.cli_client">com.vmware.vapi.metadata.cli_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.metamodel_client">com.vmware.vapi.metadata.metamodel_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.privilege_client">com.vmware.vapi.metadata.privilege_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.std.html">com.vmware.vapi.std package</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.html#module-com.vmware.vapi.std_client">com.vmware.vapi.std_client module</a></li>
|
|||
|
|
</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.deployment.html">com.vmware.vcenter.deployment package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html">com.vmware.vcenter.deployment.install package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html">com.vmware.vcenter.deployment.install.initial_config package</a><ul>
|
|||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#module-com.vmware.vcenter.deployment.install.initial_config.remote_psc_client">com.vmware.vcenter.deployment.install.initial_config.remote_psc_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#module-com.vmware.vcenter.deployment.install.psc_client">com.vmware.vcenter.deployment.install.psc_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.html#module-com.vmware.vcenter.deployment.install_client">com.vmware.vcenter.deployment.install_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.hvc.html">com.vmware.vcenter.hvc package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.hvc.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html">com.vmware.vcenter.hvc.links package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#module-com.vmware.vcenter.hvc.links.sync_client">com.vmware.vcenter.hvc.links.sync_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.hvc.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc.links_client">com.vmware.vcenter.hvc.links_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc.management_client">com.vmware.vcenter.hvc.management_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.storage.html">com.vmware.vcenter.storage package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.storage.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html">com.vmware.vcenter.storage.policies package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html#module-com.vmware.vcenter.storage.policies.compliance_client">com.vmware.vcenter.storage.policies.compliance_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.storage.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.storage.html#module-com.vmware.vcenter.storage.policies_client">com.vmware.vcenter.storage.policies_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.vm.html">com.vmware.vcenter.vm package</a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html">com.vmware.vcenter.vm.hardware package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.adapter_client">com.vmware.vcenter.vm.hardware.adapter_client module</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.boot_client">com.vmware.vcenter.vm.hardware.boot_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html">com.vmware.vcenter.vm.storage package</a><ul>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#module-com.vmware.vcenter.vm.storage.policy_client">com.vmware.vcenter.vm.storage.policy_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.guest_client">com.vmware.vcenter.vm.guest_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.hardware_client">com.vmware.vcenter.vm.hardware_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.storage_client">com.vmware.vcenter.vm.storage_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</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.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.hvc_client">com.vmware.vcenter.hvc_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.inventory_client">com.vmware.vcenter.inventory_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.iso_client">com.vmware.vcenter.iso_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.ovf_client">com.vmware.vcenter.ovf_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.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.vm_client">com.vmware.vcenter.vm_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.vm_template_client">com.vmware.vcenter.vm_template_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="submodules">
|
|||
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance_client">
|
|||
|
|
<span id="com-vmware-appliance-client-module"></span><h2>com.vmware.appliance_client module<a class="headerlink" href="#module-com.vmware.appliance_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance_client</span></code> module provides classes for managing
|
|||
|
|
vCenter Appliance configuration. The module is available starting in vSphere
|
|||
|
|
6.7.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Health">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">Health</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Health" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Health</span></code> class provides methods to retrieve the appliance health
|
|||
|
|
information. This class was added in vSphere API 6.7</p>
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Health.messages">
|
|||
|
|
<code class="descname">messages</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Health.messages" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get health messages. This method was added in vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>item</strong> (<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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of the health messages</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
Unknown health item</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">LocalAccounts</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalAccounts</span></code> class provides methods to manage local user account.
|
|||
|
|
This class was added in vSphere API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.Config">
|
|||
|
|
<em class="property">class </em><code class="descname">Config</code><span class="sig-paren">(</span><em>password=None</em>, <em>old_password=None</em>, <em>full_name=None</em>, <em>email=None</em>, <em>roles=None</em>, <em>enabled=None</em>, <em>password_expires=None</em>, <em>password_expires_at=None</em>, <em>inactive_after_password_expiration=None</em>, <em>days_after_password_expiration=None</em>, <em>min_days_between_password_change=None</em>, <em>max_days_between_password_change=None</em>, <em>warn_days_before_password_expiration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.Config" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalAccounts.Config</span></code> class defines the information required for the
|
|||
|
|
account. This class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>fullname=None</em>, <em>email=None</em>, <em>roles=None</em>, <em>enabled=None</em>, <em>has_password=None</em>, <em>last_password_change=None</em>, <em>password_expires_at=None</em>, <em>inactive_at=None</em>, <em>min_days_between_password_change=None</em>, <em>max_days_between_password_change=None</em>, <em>warn_days_before_password_expiration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalAccounts.Info</span></code> class defines the local account properties. This
|
|||
|
|
class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.UpdateConfig">
|
|||
|
|
<em class="property">class </em><code class="descname">UpdateConfig</code><span class="sig-paren">(</span><em>password=None</em>, <em>old_password=None</em>, <em>full_name=None</em>, <em>email=None</em>, <em>roles=None</em>, <em>enabled=None</em>, <em>password_expires=None</em>, <em>password_expires_at=None</em>, <em>inactive_after_password_expiration=None</em>, <em>days_after_password_expiration=None</em>, <em>min_days_between_password_change=None</em>, <em>max_days_between_password_change=None</em>, <em>warn_days_before_password_expiration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.UpdateConfig" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalAccounts.UpdateConfig</span></code> class defines the fields that might be
|
|||
|
|
updated. This class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.create">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>username</em>, <em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Create a new local user account. This method was added in vSphere API
|
|||
|
|
6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>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>.</li>
|
|||
|
|
<li><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</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code>
|
|||
|
|
If an account already exists</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
If a username is invalid (username is validated against
|
|||
|
|
[a-zA-Z0-9][a-zA-Z0-9-.\@]\*[a-zA-Z0-9] pattern)</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.delete">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>username</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Delete a local user account. This method was added in vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
If the account is not found</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>username</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get the local user account information. This method was added in
|
|||
|
|
vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User login name</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Local user account information</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
If the account is not found</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.list">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.set">
|
|||
|
|
<code class="descname">set</code><span class="sig-paren">(</span><em>username</em>, <em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.set" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set local user account properties. This method was added in vSphere API
|
|||
|
|
6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>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>.</li>
|
|||
|
|
<li><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</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
If the account is not found</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.LocalAccounts.update">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>username</em>, <em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.LocalAccounts.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Update selected fields in local user account properties. This method
|
|||
|
|
was added in vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>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>.</li>
|
|||
|
|
<li><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</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
If the account is not found</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">Monitoring</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Monitoring</span></code> class provides methods Get and list monitoring data for
|
|||
|
|
requested item.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.FunctionType">
|
|||
|
|
<em class="property">class </em><code class="descname">FunctionType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.FunctionType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Monitoring.FunctionType</span></code> class Defines aggregation function</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.FunctionType.AVG">
|
|||
|
|
<code class="descname">AVG</code><em class="property"> = FunctionType(string='AVG')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.FunctionType.AVG" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Aggregation takes average per period</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.FunctionType.COUNT">
|
|||
|
|
<code class="descname">COUNT</code><em class="property"> = FunctionType(string='COUNT')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.FunctionType.COUNT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Aggregation takes count per period (sum)</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.FunctionType.MAX">
|
|||
|
|
<code class="descname">MAX</code><em class="property"> = FunctionType(string='MAX')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.FunctionType.MAX" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Aggregation takes maximums per period</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.FunctionType.MIN">
|
|||
|
|
<code class="descname">MIN</code><em class="property"> = FunctionType(string='MIN')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.FunctionType.MIN" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Aggregation takes minimums per period</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType">
|
|||
|
|
<em class="property">class </em><code class="descname">IntervalType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Monitoring.IntervalType</span></code> class Defines interval between the values in
|
|||
|
|
hours and mins, for which aggregation will apply</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType.DAY1">
|
|||
|
|
<code class="descname">DAY1</code><em class="property"> = IntervalType(string='DAY1')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType.DAY1" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>24 hours interval between values. One year has 365 values.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType.HOURS2">
|
|||
|
|
<code class="descname">HOURS2</code><em class="property"> = IntervalType(string='HOURS2')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType.HOURS2" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Two hours interval between values. One month has 360 values.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType.HOURS6">
|
|||
|
|
<code class="descname">HOURS6</code><em class="property"> = IntervalType(string='HOURS6')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType.HOURS6" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Six hour interval between values. One quarter is 360 values.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType.MINUTES30">
|
|||
|
|
<code class="descname">MINUTES30</code><em class="property"> = IntervalType(string='MINUTES30')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType.MINUTES30" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Thirty minutes interval between values. One week is 336 values.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.IntervalType.MINUTES5">
|
|||
|
|
<code class="descname">MINUTES5</code><em class="property"> = IntervalType(string='MINUTES5')</em><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.IntervalType.MINUTES5" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Five minutes interval between values (finest). One day would have 288
|
|||
|
|
values, one week is 2016.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.MonitoredItem">
|
|||
|
|
<em class="property">class </em><code class="descname">MonitoredItem</code><span class="sig-paren">(</span><em>id=None</em>, <em>name=None</em>, <em>units=None</em>, <em>category=None</em>, <em>instance=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.MonitoredItem" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Monitoring.MonitoredItem</span></code> class Structure representing requested
|
|||
|
|
monitored item data.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.MonitoredItemData">
|
|||
|
|
<em class="property">class </em><code class="descname">MonitoredItemData</code><span class="sig-paren">(</span><em>name=None</em>, <em>interval=None</em>, <em>function=None</em>, <em>start_time=None</em>, <em>end_time=None</em>, <em>data=None</em><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="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest">
|
|||
|
|
<em class="property">class </em><code class="descname">MonitoredItemDataRequest</code><span class="sig-paren">(</span><em>names=None</em>, <em>interval=None</em>, <em>function=None</em>, <em>start_time=None</em>, <em>end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Monitoring.MonitoredItemDataRequest</span></code> class Structure representing
|
|||
|
|
requested monitored item data.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>stat_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get monitored item info</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stat_id</strong> (<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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.Monitoring.MonitoredItem" title="com.vmware.appliance_client.Monitoring.MonitoredItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">Monitoring.MonitoredItem</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">MonitoredItem structure</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.list">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.Monitoring.list" title="com.vmware.appliance_client.Monitoring.list"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of names</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Monitoring.query">
|
|||
|
|
<code class="descname">query</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Monitoring.query" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get monitoring data.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>item</strong> (<a class="reference internal" href="#com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest" title="com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">Monitoring.MonitoredItemDataRequest</span></code></a>) – MonitoredItemDataRequest Structure</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.Monitoring.list" title="com.vmware.appliance_client.Monitoring.list"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of MonitoredItemData structure</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">Networking</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Networking</span></code> class provides methods Get Network configurations. This
|
|||
|
|
class was added in vSphere API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.DNSInfo">
|
|||
|
|
<em class="property">class </em><code class="descname">DNSInfo</code><span class="sig-paren">(</span><em>mode=None</em>, <em>hostname=None</em>, <em>servers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.DNSInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Networking.DNSInfo</span></code> class contains information about the DNS
|
|||
|
|
configuration of a virtual appliance. This class was added in vSphere API
|
|||
|
|
6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.DNSInfo.DNSMode">
|
|||
|
|
<em class="property">class </em><code class="descname">DNSMode</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.DNSInfo.DNSMode" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Networking.DNSInfo.DNSMode</span></code> class describes the source of DNS
|
|||
|
|
servers. This enumeration was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.DNSInfo.DNSMode.DHCP">
|
|||
|
|
<code class="descname">DHCP</code><em class="property"> = DNSMode(string='DHCP')</em><a class="headerlink" href="#com.vmware.appliance_client.Networking.DNSInfo.DNSMode.DHCP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The DNS servers addresses are obtained from a DHCP server. This class
|
|||
|
|
attribute was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.DNSInfo.DNSMode.STATIC">
|
|||
|
|
<code class="descname">STATIC</code><em class="property"> = DNSMode(string='STATIC')</em><a class="headerlink" href="#com.vmware.appliance_client.Networking.DNSInfo.DNSMode.STATIC" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The DNS servers addresses are specified explicitly. This class attribute
|
|||
|
|
was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>dns=None</em>, <em>interfaces=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Networking.Info</span></code> class contains information about the network
|
|||
|
|
configuration of a virtual appliance. This class was added in vSphere API
|
|||
|
|
6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>ipv6_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Networking.UpdateSpec</span></code> class describes whether to enable or disable
|
|||
|
|
ipv6 on interfaces. This class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.get">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The Map of network configuration info for all interfaces.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.reset">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Networking.update">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Networking.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Enable or Disable ipv6 on all interfaces. This method was added in
|
|||
|
|
vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.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</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Notification">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">Notification</code><span class="sig-paren">(</span><em>id=None</em>, <em>time=None</em>, <em>message=None</em>, <em>resolution=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Notification" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Notification</span></code> class describes a notification that can be reported by
|
|||
|
|
the appliance task. This class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Notifications">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">Notifications</code><span class="sig-paren">(</span><em>info=None</em>, <em>warnings=None</em>, <em>errors=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Notifications" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Notifications</span></code> class contains info/warning/error messages that can
|
|||
|
|
be reported be the appliance task. This class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">Ntp</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Ntp</span></code> class provides methods Gets NTP configuration status and tests
|
|||
|
|
connection to ntp servers. This class was added in vSphere API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.LocalizableMessage">
|
|||
|
|
<em class="property">class </em><code class="descname">LocalizableMessage</code><span class="sig-paren">(</span><em>id=None</em>, <em>default_message=None</em>, <em>args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp.LocalizableMessage" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Ntp.LocalizableMessage</span></code> class Structure representing message. This class
|
|||
|
|
was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.ServerStatus">
|
|||
|
|
<em class="property">class </em><code class="descname">ServerStatus</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp.ServerStatus" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Ntp.ServerStatus</span></code> class Status of server during test. This enumeration
|
|||
|
|
was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.ServerStatus.SERVER_REACHABLE">
|
|||
|
|
<code class="descname">SERVER_REACHABLE</code><em class="property"> = ServerStatus(string='SERVER_REACHABLE')</em><a class="headerlink" href="#com.vmware.appliance_client.Ntp.ServerStatus.SERVER_REACHABLE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Server is reachable. This class attribute was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.ServerStatus.SERVER_UNREACHABLE">
|
|||
|
|
<code class="descname">SERVER_UNREACHABLE</code><em class="property"> = ServerStatus(string='SERVER_UNREACHABLE')</em><a class="headerlink" href="#com.vmware.appliance_client.Ntp.ServerStatus.SERVER_UNREACHABLE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Server is unreachable. This class attribute was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.TestRunStatus">
|
|||
|
|
<em class="property">class </em><code class="descname">TestRunStatus</code><span class="sig-paren">(</span><em>server=None</em>, <em>status=None</em>, <em>message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp.TestRunStatus" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Ntp.TestRunStatus</span></code> class Status of the test. This class was added in
|
|||
|
|
vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.get">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of NTP servers.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.set">
|
|||
|
|
<code class="descname">set</code><span class="sig-paren">(</span><em>servers</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp.set" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set NTP servers. This method updates old NTP servers from configuration
|
|||
|
|
and sets the input NTP servers in the configuration. If NTP based time
|
|||
|
|
synchronization is used internally, the NTP daemon will be restarted to
|
|||
|
|
reload given NTP configuration. In case NTP based time synchronization
|
|||
|
|
is not used, this method only replaces servers in the NTP
|
|||
|
|
configuration. This method was added in vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Ntp.test">
|
|||
|
|
<code class="descname">test</code><span class="sig-paren">(</span><em>servers</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Ntp.test" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Test the connection to a list of ntp servers. This method was added in
|
|||
|
|
vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of test run statuses.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Recovery">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">Recovery</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Recovery" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Recovery</span></code> class provides methods to invoke an appliance recovery
|
|||
|
|
(backup and restore). This class was added in vSphere API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Recovery.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>supported=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Recovery.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Recovery.Info</span></code> class contains the information about the appliance
|
|||
|
|
recovery environment. This class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Recovery.get">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Structure containing the properties of the Recovery subsystem.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if any error occurs during the execution of the operation.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">Services</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Service</span></code> class provides methods to manage a single/set of appliance
|
|||
|
|
services. This class was added in vSphere API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>description=None</em>, <em>state=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Services.Info</span></code> class contains information about a service. This
|
|||
|
|
class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.State">
|
|||
|
|
<em class="property">class </em><code class="descname">State</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.State" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Services.State</span></code> class defines valid Run State for services. This
|
|||
|
|
enumeration was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.State.STARTED">
|
|||
|
|
<code class="descname">STARTED</code><em class="property"> = State(string='STARTED')</em><a class="headerlink" href="#com.vmware.appliance_client.Services.State.STARTED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Service Run State is Started, it is fully functional. This class attribute
|
|||
|
|
was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.State.STARTING">
|
|||
|
|
<code class="descname">STARTING</code><em class="property"> = State(string='STARTING')</em><a class="headerlink" href="#com.vmware.appliance_client.Services.State.STARTING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Service Run State is Starting, it is still not functional. This class
|
|||
|
|
attribute was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.State.STOPPED">
|
|||
|
|
<code class="descname">STOPPED</code><em class="property"> = State(string='STOPPED')</em><a class="headerlink" href="#com.vmware.appliance_client.Services.State.STOPPED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Service Run State is Stopped. This class attribute was added in vSphere API
|
|||
|
|
6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.State.STOPPING">
|
|||
|
|
<code class="descname">STOPPING</code><em class="property"> = State(string='STOPPING')</em><a class="headerlink" href="#com.vmware.appliance_client.Services.State.STOPPING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Service Run State is Stopping, it is not functional. This class attribute
|
|||
|
|
was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns the state of a service. This method was added in vSphere API
|
|||
|
|
6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Service Info structure.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if any other error occurs during the execution of the operation.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.list">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if any error occurs during the execution of the operation.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.restart">
|
|||
|
|
<code class="descname">restart</code><span class="sig-paren">(</span><em>service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.restart" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Restarts a service. This method was added in vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code>
|
|||
|
|
if any timeout occurs during the execution of the restart
|
|||
|
|
operation.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if a restart operation is issued on a service which has startup
|
|||
|
|
type null</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if any other error occurs during the execution of the operation.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.start">
|
|||
|
|
<code class="descname">start</code><span class="sig-paren">(</span><em>service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.start" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Starts a service. This method was added in vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if start operation is issued on a service which has startup type
|
|||
|
|
null.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code>
|
|||
|
|
if any timeout occurs during the execution of the start operation.
|
|||
|
|
Timeout occurs when the service takes longer than StartTimeout to
|
|||
|
|
start.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if any other error occurs during the execution of the operation.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Services.stop">
|
|||
|
|
<code class="descname">stop</code><span class="sig-paren">(</span><em>service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Services.stop" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Stops a service. This method was added in vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if any other error occurs during the execution of the operation.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Shutdown">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">Shutdown</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Shutdown" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Shutdown</span></code> class provides methods Performs reboot/shutdown operations on
|
|||
|
|
appliance. This class was added in vSphere API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Shutdown.ShutdownConfig">
|
|||
|
|
<em class="property">class </em><code class="descname">ShutdownConfig</code><span class="sig-paren">(</span><em>shutdown_time=None</em>, <em>action=None</em>, <em>reason=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Shutdown.ShutdownConfig" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Shutdown.ShutdownConfig</span></code> class Structure that defines shutdown
|
|||
|
|
configuration returned by the Shutdown.get operation. This class was added
|
|||
|
|
in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Shutdown.cancel">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Shutdown.get">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Configuration of pending shutdown action.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Shutdown.poweroff">
|
|||
|
|
<code class="descname">poweroff</code><span class="sig-paren">(</span><em>delay</em>, <em>reason</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Shutdown.poweroff" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Power off the appliance. This method was added in vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>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.</li>
|
|||
|
|
<li><strong>reason</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Reason for peforming poweroff.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Shutdown.reboot">
|
|||
|
|
<code class="descname">reboot</code><span class="sig-paren">(</span><em>delay</em>, <em>reason</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Shutdown.reboot" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Reboot the appliance. This method was added in vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>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.</li>
|
|||
|
|
<li><strong>reason</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Reason for peforming reboot.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.SubtaskInfo">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">SubtaskInfo</code><span class="sig-paren">(</span><em>progress=None</em>, <em>result=None</em>, <em>description=None</em>, <em>service=None</em>, <em>operation=None</em>, <em>parent=None</em>, <em>target=None</em>, <em>status=None</em>, <em>cancelable=None</em>, <em>error=None</em>, <em>start_time=None</em>, <em>end_time=None</em>, <em>user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.SubtaskInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SubtaskInfo</span></code> class contains information about one of the subtasks
|
|||
|
|
that makes up an appliance task. This class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.TaskInfo">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">TaskInfo</code><span class="sig-paren">(</span><em>progress=None</em>, <em>subtask_order=None</em>, <em>subtasks=None</em>, <em>description=None</em>, <em>service=None</em>, <em>operation=None</em>, <em>parent=None</em>, <em>target=None</em>, <em>status=None</em>, <em>cancelable=None</em>, <em>error=None</em>, <em>start_time=None</em>, <em>end_time=None</em>, <em>user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.TaskInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">TaskInfo</span></code> class contains information about an appliance task and the
|
|||
|
|
subtasks of which it consists. This class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">Timesync</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Timesync" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Timesync</span></code> class provides methods Performs time synchronization
|
|||
|
|
configuration. This class was added in vSphere API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync.TimeSyncMode">
|
|||
|
|
<em class="property">class </em><code class="descname">TimeSyncMode</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Timesync.TimeSyncMode" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Timesync.TimeSyncMode</span></code> class defines time synchronization modes.
|
|||
|
|
This enumeration was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync.TimeSyncMode.DISABLED">
|
|||
|
|
<code class="descname">DISABLED</code><em class="property"> = TimeSyncMode(string='DISABLED')</em><a class="headerlink" href="#com.vmware.appliance_client.Timesync.TimeSyncMode.DISABLED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Time synchronization is disabled. This class attribute was added in vSphere
|
|||
|
|
API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync.TimeSyncMode.HOST">
|
|||
|
|
<code class="descname">HOST</code><em class="property"> = TimeSyncMode(string='HOST')</em><a class="headerlink" href="#com.vmware.appliance_client.Timesync.TimeSyncMode.HOST" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>VMware Tool-based time synchronization. This class attribute was added in
|
|||
|
|
vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync.TimeSyncMode.NTP">
|
|||
|
|
<code class="descname">NTP</code><em class="property"> = TimeSyncMode(string='NTP')</em><a class="headerlink" href="#com.vmware.appliance_client.Timesync.TimeSyncMode.NTP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>NTP-based time synchronization. This class attribute was added in vSphere
|
|||
|
|
API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync.get">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Time synchronization mode.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Timesync.set">
|
|||
|
|
<code class="descname">set</code><span class="sig-paren">(</span><em>mode</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Timesync.set" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set time synchronization mode. This method was added in vSphere API 6.7</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.appliance_client.</code><code class="descname">Update</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Update</span></code> class provides methods to get the status of the appliance
|
|||
|
|
update. This class was added in vSphere API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>state=None</em>, <em>task=None</em>, <em>version=None</em>, <em>latest_query_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Update.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Update.Info</span></code> class describes the state of the appliance update. This
|
|||
|
|
class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State">
|
|||
|
|
<em class="property">class </em><code class="descname">State</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance_client.Update.State" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Update.State</span></code> class defines the various states the appliance update
|
|||
|
|
can be in. This enumeration was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State.INSTALL_FAILED">
|
|||
|
|
<code class="descname">INSTALL_FAILED</code><em class="property"> = State(string='INSTALL_FAILED')</em><a class="headerlink" href="#com.vmware.appliance_client.Update.State.INSTALL_FAILED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The appliance update failed and cannot recover. This class attribute was
|
|||
|
|
added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State.INSTALL_IN_PROGRESS">
|
|||
|
|
<code class="descname">INSTALL_IN_PROGRESS</code><em class="property"> = State(string='INSTALL_IN_PROGRESS')</em><a class="headerlink" href="#com.vmware.appliance_client.Update.State.INSTALL_IN_PROGRESS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The appliance update is in progress of installing an update. This class
|
|||
|
|
attribute was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State.ROLLBACK_IN_PROGRESS">
|
|||
|
|
<code class="descname">ROLLBACK_IN_PROGRESS</code><em class="property"> = State(string='ROLLBACK_IN_PROGRESS')</em><a class="headerlink" href="#com.vmware.appliance_client.Update.State.ROLLBACK_IN_PROGRESS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The appliance update failed and recovery is in progress. This class
|
|||
|
|
attribute was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State.STAGE_IN_PROGRESS">
|
|||
|
|
<code class="descname">STAGE_IN_PROGRESS</code><em class="property"> = State(string='STAGE_IN_PROGRESS')</em><a class="headerlink" href="#com.vmware.appliance_client.Update.State.STAGE_IN_PROGRESS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The appliance update is in progress of downloading an update. This class
|
|||
|
|
attribute was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State.UPDATES_PENDING">
|
|||
|
|
<code class="descname">UPDATES_PENDING</code><em class="property"> = State(string='UPDATES_PENDING')</em><a class="headerlink" href="#com.vmware.appliance_client.Update.State.UPDATES_PENDING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>A new update is available. This class attribute was added in vSphere API
|
|||
|
|
6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.State.UP_TO_DATE">
|
|||
|
|
<code class="descname">UP_TO_DATE</code><em class="property"> = State(string='UP_TO_DATE')</em><a class="headerlink" href="#com.vmware.appliance_client.Update.State.UP_TO_DATE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The appliance is up to date. This class attribute was added in vSphere API
|
|||
|
|
6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.cancel">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
Current task is not cancellable</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
session is not authenticated</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
session is not authorized to perform this operation</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance_client.Update.get">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance_client.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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Info structure containing the status information about the
|
|||
|
|
appliance.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
Generic error</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
session is not authenticated</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
session is not authorized to perform this operation</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.cis_client">
|
|||
|
|
<span id="com-vmware-cis-client-module"></span><h2>com.vmware.cis_client module<a class="headerlink" href="#module-com.vmware.cis_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.cis_client</span></code> module provides VMware common infrastructure
|
|||
|
|
classes.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.cis_client.Session">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.cis_client.</code><code class="descname">Session</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis_client.Session" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Session</span></code> class allows API clients to manage session tokens including
|
|||
|
|
creating, deleting and obtaining information about sessions.</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li>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.</li>
|
|||
|
|
<li>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.</li>
|
|||
|
|
<li>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.</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>Connect to lookup service.</li>
|
|||
|
|
<li>Discover the secure token service (STS) endpoint URL.</li>
|
|||
|
|
<li>Connect to the secure token service to obtain a SAML token.</li>
|
|||
|
|
<li>Authenticate to the lookup service using the obtained SAML token.</li>
|
|||
|
|
<li>Discover the API endpoint URL from lookup service.</li>
|
|||
|
|
<li>Call the <a class="reference internal" href="#com.vmware.cis_client.Session.create" title="com.vmware.cis_client.Session.create"><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.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>See the programming guide and samples for additional information about
|
|||
|
|
establishing API sessions.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><strong>Execution Context and Security Context</strong></div></blockquote>
|
|||
|
|
<p>To use session based authentication a client should supply the session
|
|||
|
|
token obtained through the <a class="reference internal" href="#com.vmware.cis_client.Session.create" title="com.vmware.cis_client.Session.create"><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><strong>Session Lifetime</strong></div></blockquote>
|
|||
|
|
<p>A session begins with call to the <a class="reference internal" href="#com.vmware.cis_client.Session.create" title="com.vmware.cis_client.Session.create"><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>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.</li>
|
|||
|
|
<li>The session expires. Session expiration may be caused by one of the
|
|||
|
|
following situations:</li>
|
|||
|
|
<li>Client inactivity - For a particular session identified by client
|
|||
|
|
requests that specify the associated session ID, the lapsed time since the
|
|||
|
|
last request exceeds the maximum interval between requests.</li>
|
|||
|
|
<li>Unconditional or absolute session expiration time: At the beginning of
|
|||
|
|
the session, the session logic uses the SAML token and the system
|
|||
|
|
configuration to calculate absolute expiration time.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>When a session ends, the authentication logic will reject any subsequent
|
|||
|
|
client requests that specify that session. Any operations in progress will
|
|||
|
|
continue to completion.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p><strong>Error Handling</strong></p>
|
|||
|
|
<p>The <a class="reference internal" href="#com.vmware.cis_client.Session" title="com.vmware.cis_client.Session"><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><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code> exception for
|
|||
|
|
any exceptions related to the request.</li>
|
|||
|
|
<li><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code> exception
|
|||
|
|
for all exceptions caused by internal service failure.</li>
|
|||
|
|
</ul>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.cis_client.Session.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>user=None</em>, <em>created_time=None</em>, <em>last_accessed_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis_client.Session.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Represents data associated with an API session.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.cis_client.Session.create">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Newly created session identifier to be used for authenticating
|
|||
|
|
further requests.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the session creation fails due to request specific issues. Due
|
|||
|
|
to the security nature of the API the details of the error are not
|
|||
|
|
disclosed.</p>
|
|||
|
|
<p>Please check the following preconditions if using a SAML token to
|
|||
|
|
authenticate:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li>the supplied token is delegate-able.</li>
|
|||
|
|
<li>the time of client and server system are synchronized.</li>
|
|||
|
|
<li>the token supplied is valid.</li>
|
|||
|
|
<li>if bearer tokens are used check that system configuration allows
|
|||
|
|
the API endpoint to accept such tokens.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if session creation fails due to server specific issues, for
|
|||
|
|
example connection to a back end component is failing. Due to the
|
|||
|
|
security nature of this API further details will not be disclosed
|
|||
|
|
in the exception. Please refer to component health information,
|
|||
|
|
administrative logs and product specific documentation for possible
|
|||
|
|
causes.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.cis_client.Session.delete">
|
|||
|
|
<code class="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>A session identifier is expected as part of the request.</div></blockquote>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the session id is missing from the request or the corresponding
|
|||
|
|
session object cannot be found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if session deletion fails due to server specific issues, for
|
|||
|
|
example connection to a back end component is failing. Due to the
|
|||
|
|
security nature of this API further details will not be disclosed
|
|||
|
|
in the exception. Please refer to component health information,
|
|||
|
|
administrative logs and product specific documentation for possible
|
|||
|
|
causes.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.cis_client.Session.get">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.cis_client.Session.Info" title="com.vmware.cis_client.Session.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Session.Info</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Information about the session.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the session id is missing from the request or the corresponding
|
|||
|
|
session object cannot be found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if session retrieval fails due to server specific issues e.g.
|
|||
|
|
connection to back end component is failing. Due to the security
|
|||
|
|
nature of this API further details will not be disclosed in the
|
|||
|
|
error. Please refer to component health information, administrative
|
|||
|
|
logs and product specific documentation for possible causes.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.cis_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.cis_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.content_client">
|
|||
|
|
<span id="com-vmware-content-client-module"></span><h2>com.vmware.content_client module<a class="headerlink" href="#module-com.vmware.content_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The Content module provides classes and classes for configuring global settings
|
|||
|
|
and permissions, and for managing libraries in the Content Library Service.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.Configuration">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content_client.</code><code class="descname">Configuration</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Configuration" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Configuration</span></code> class provides methods to configure the global
|
|||
|
|
settings of the Content Library Service.</p>
|
|||
|
|
<p>The configuration settings are used by the Content Library Service to
|
|||
|
|
control the behavior of various operations.</p>
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Configuration.get">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModel</span></code></a></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">ContentLibrary.GetConfiguration</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Configuration.update">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Configuration.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Updates the configuration. The update is incremental. Any attribute in
|
|||
|
|
the <a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModel</span></code></a> class that is None will not be
|
|||
|
|
modified. Note that this update method doesn’t guarantee an atomic
|
|||
|
|
change of all the properties. In the case of a system crash or failure,
|
|||
|
|
some of the properties could be left unchanged while others may be
|
|||
|
|
updated.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>model</strong> (<a class="reference internal" href="#com.vmware.content_client.ConfigurationModel" title="com.vmware.content_client.ConfigurationModel"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if one of the configuration properties is not within the proper
|
|||
|
|
range.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">ContentLibrary.UpdateConfiguration</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.ConfigurationModel">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content_client.</code><code class="descname">ConfigurationModel</code><span class="sig-paren">(</span><em>automatic_sync_enabled=None</em>, <em>automatic_sync_start_hour=None</em>, <em>automatic_sync_stop_hour=None</em>, <em>maximum_concurrent_item_syncs=None</em><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="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.Library">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content_client.</code><code class="descname">Library</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Library" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Library</span></code> class provides methods to manage and find
|
|||
|
|
<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a> entities.</p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Library</span></code> class provides support for generic functionality which can
|
|||
|
|
be applied equally to all types of libraries. The functionality provided by
|
|||
|
|
this class will not affect the properties specific to the type of library.
|
|||
|
|
See also <a class="reference internal" href="#com.vmware.content_client.LocalLibrary" title="com.vmware.content_client.LocalLibrary"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalLibrary</span></code></a> and <a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary" title="com.vmware.content_client.SubscribedLibrary"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubscribedLibrary</span></code></a>.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.Library.FindSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">FindSpec</code><span class="sig-paren">(</span><em>name=None</em>, <em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Library.FindSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Specifies the properties that can be used as a filter to find libraries.
|
|||
|
|
When multiple attributes are specified, all properties of the library must
|
|||
|
|
match the specification.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.Library.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.Library'</em><a class="headerlink" href="#com.vmware.content_client.Library.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Resource type for library.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Library.find">
|
|||
|
|
<code class="descname">find</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Library.find" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns a list of all the visible (as determined by authorization
|
|||
|
|
policy) libraries matching the requested <a class="reference internal" href="#com.vmware.content_client.Library.FindSpec" title="com.vmware.content_client.Library.FindSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Library.FindSpec</span></code></a>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.content_client.Library.FindSpec" title="com.vmware.content_client.Library.FindSpec"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.Library.list" title="com.vmware.content_client.Library.list"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.Library.list" title="com.vmware.content_client.Library.list"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if no properties are specified in the <code class="docutils literal notranslate"><span class="pre">spec</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Library.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>library_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Library.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns a given <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the specified library does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>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>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Library.list">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.Library.list" title="com.vmware.content_client.Library.list"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.Library.list" title="com.vmware.content_client.Library.list"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Library.update">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>library_id</em>, <em>update_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Library.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Updates the properties of a library.</p>
|
|||
|
|
<p>This is an incremental update to the library. Any attribute in the
|
|||
|
|
<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a> class that is None will not be modified.</p>
|
|||
|
|
<p>This method will only update the common properties for all library
|
|||
|
|
types. This will not, for example, update the
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.publish_info</span></code> of a local library, nor the
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.subscription_info</span></code> of a subscribed library.
|
|||
|
|
Specific properties are updated in <a class="reference internal" href="#com.vmware.content_client.LocalLibrary.update" title="com.vmware.content_client.LocalLibrary.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">LocalLibrary.update()</span></code></a> and
|
|||
|
|
<a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.update" title="com.vmware.content_client.SubscribedLibrary.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">SubscribedLibrary.update()</span></code></a>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>library_id</strong> (<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>.</li>
|
|||
|
|
<li><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.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the library associated with <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is not valid.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if 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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>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>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.LibraryModel">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content_client.</code><code class="descname">LibraryModel</code><span class="sig-paren">(</span><em>id=None</em>, <em>creation_time=None</em>, <em>description=None</em>, <em>last_modified_time=None</em>, <em>last_sync_time=None</em>, <em>name=None</em>, <em>storage_backings=None</em>, <em>type=None</em>, <em>optimization_info=None</em>, <em>version=None</em>, <em>publish_info=None</em>, <em>subscription_info=None</em>, <em>server_guid=None</em><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="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.LibraryModel.LibraryType">
|
|||
|
|
<em class="property">class </em><code class="descname">LibraryType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.LibraryModel.LibraryType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryModel.LibraryType</span></code> class defines the type of a
|
|||
|
|
<a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a>.</p>
|
|||
|
|
<p>The type of a library can be used to determine which additional services
|
|||
|
|
can be performed with a library.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.LibraryModel.LibraryType.LOCAL">
|
|||
|
|
<code class="descname">LOCAL</code><em class="property"> = LibraryType(string='LOCAL')</em><a class="headerlink" href="#com.vmware.content_client.LibraryModel.LibraryType.LOCAL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The library contents are defined and stored by the local Content Library
|
|||
|
|
Service installation.</p>
|
|||
|
|
<p>A local library can be retrieved and managed via the <a class="reference internal" href="#com.vmware.content_client.LocalLibrary" title="com.vmware.content_client.LocalLibrary"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalLibrary</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.LibraryModel.LibraryType.SUBSCRIBED">
|
|||
|
|
<code class="descname">SUBSCRIBED</code><em class="property"> = LibraryType(string='SUBSCRIBED')</em><a class="headerlink" href="#com.vmware.content_client.LibraryModel.LibraryType.SUBSCRIBED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The library synchronizes its items and content from another published
|
|||
|
|
library.</p>
|
|||
|
|
<p>A subscribed library can be retrieved and managed via the
|
|||
|
|
<a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary" title="com.vmware.content_client.SubscribedLibrary"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubscribedLibrary</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content_client.</code><code class="descname">LocalLibrary</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.LocalLibrary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalLibrary</span></code> class manages local libraries.</p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalLibrary</span></code> class provides support for creating and maintaining
|
|||
|
|
local library instances. A local library may also use the <a class="reference internal" href="#com.vmware.content_client.Library" title="com.vmware.content_client.Library"><code class="xref py py-class docutils literal notranslate"><span class="pre">Library</span></code></a>
|
|||
|
|
class to manage general library functionality.</p>
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary.create">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>create_spec</em>, <em>client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.LocalLibrary.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Creates a new local library.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>client_token</strong> (<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.</li>
|
|||
|
|
<li><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.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Identifier of the 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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">create_spec</span></code> is not valid.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">client_token</span></code> does not conform to the UUID format.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code>
|
|||
|
|
if using multiple storage backings.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">ContentLibrary.CreateLocalLibrary</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary.delete">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>library_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.LocalLibrary.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Deletes the specified local library.</p>
|
|||
|
|
<p>Deleting a local library will remove the entry immediately and begin an
|
|||
|
|
asynchronous task to remove all cached content for the library. If the
|
|||
|
|
asynchronous task fails, file content may remain on the storage
|
|||
|
|
backing. This content will require manual removal.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a local library.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>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>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>library_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.LocalLibrary.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns a given local library.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a local library.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>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>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary.list">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.LocalLibrary.list" title="com.vmware.content_client.LocalLibrary.list"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.LocalLibrary.list" title="com.vmware.content_client.LocalLibrary.list"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.LocalLibrary.update">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>library_id</em>, <em>update_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.LocalLibrary.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Updates the properties of a local library.</p>
|
|||
|
|
<p>This is an incremental update to the local library. Attributes that are
|
|||
|
|
None in the update specification will be left unchanged.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>library_id</strong> (<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>.</li>
|
|||
|
|
<li><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.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a local library.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is not valid.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if 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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ConcurrentChange</span></code>
|
|||
|
|
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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>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>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content_client.</code><code class="descname">SubscribedLibrary</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult">
|
|||
|
|
<em class="property">class </em><code class="descname">ProbeResult</code><span class="sig-paren">(</span><em>status=None</em>, <em>ssl_thumbprint=None</em>, <em>error_messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SubscribedLibrary.ProbeResult</span></code> class defines the subscription
|
|||
|
|
information probe result. This describes whether using a given subscription
|
|||
|
|
URL is successful or if there are access problems, such as SSL errors.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status">
|
|||
|
|
<em class="property">class </em><code class="descname">Status</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SubscribedLibrary.ProbeResult.Status</span></code> class defines the error status
|
|||
|
|
constants for the probe result.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.CERTIFICATE_ERROR">
|
|||
|
|
<code class="descname">CERTIFICATE_ERROR</code><em class="property"> = Status(string='CERTIFICATE_ERROR')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.CERTIFICATE_ERROR" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that the provided server certificate thumbprint in
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.ssl_thumbprint</span></code>
|
|||
|
|
is invalid. In this case, the returned null should be set in
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.ssl_thumbprint</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.HOST_NOT_FOUND">
|
|||
|
|
<code class="descname">HOST_NOT_FOUND</code><em class="property"> = Status(string='HOST_NOT_FOUND')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.HOST_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that the host in the URL could not be found.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.INVALID_CREDENTIALS">
|
|||
|
|
<code class="descname">INVALID_CREDENTIALS</code><em class="property"> = Status(string='INVALID_CREDENTIALS')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.INVALID_CREDENTIALS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that the connection was rejected due to invalid credentials.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.INVALID_URL">
|
|||
|
|
<code class="descname">INVALID_URL</code><em class="property"> = Status(string='INVALID_URL')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.INVALID_URL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that the supplied URL was not valid.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.RESOURCE_NOT_FOUND">
|
|||
|
|
<code class="descname">RESOURCE_NOT_FOUND</code><em class="property"> = Status(string='RESOURCE_NOT_FOUND')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.RESOURCE_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that the given resource at the URL was not found.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.SUCCESS">
|
|||
|
|
<code class="descname">SUCCESS</code><em class="property"> = Status(string='SUCCESS')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.SUCCESS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that the probe was successful.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.TIMED_OUT">
|
|||
|
|
<code class="descname">TIMED_OUT</code><em class="property"> = Status(string='TIMED_OUT')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.TIMED_OUT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that the probe timed out while attempting to connect to the URL.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.UNKNOWN_ERROR">
|
|||
|
|
<code class="descname">UNKNOWN_ERROR</code><em class="property"> = Status(string='UNKNOWN_ERROR')</em><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.UNKNOWN_ERROR" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates an unspecified error different from the other error cases defined
|
|||
|
|
in <a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status" title="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubscribedLibrary.ProbeResult.Status</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.create">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>create_spec</em>, <em>client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Creates a new subscribed library.</p>
|
|||
|
|
<p>Once created, the subscribed library will be empty. If the
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryModel.subscription_info</span></code> property is set, the Content
|
|||
|
|
Library Service will attempt to synchronize to the remote source. This
|
|||
|
|
is an asynchronous operation so the content of the published library
|
|||
|
|
may not immediately appear.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>client_token</strong> (<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.</li>
|
|||
|
|
<li><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.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Identifier of the 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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">create_spec</span></code> is not valid.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">client_token</span></code> does not conform to the UUID format.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code>
|
|||
|
|
if using multiple storage backings.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
if subscribing to a published library which cannot be accessed.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.CreateSubscribedLibrary</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.delete">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>library_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Deletes the specified subscribed library.</p>
|
|||
|
|
<p>Deleting a subscribed library will remove the entry immediately and
|
|||
|
|
begin an asynchronous task to remove all cached content for the
|
|||
|
|
library. If the asynchronous task fails, file content may remain on the
|
|||
|
|
storage backing. This content will require manual removal.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code>
|
|||
|
|
if the library referenced by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a subscribed
|
|||
|
|
library.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the library referenced by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>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>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.evict">
|
|||
|
|
<code class="descname">evict</code><span class="sig-paren">(</span><em>library_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.evict" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Evicts the cached content of an on-demand subscribed library.</p>
|
|||
|
|
<p>This method allows the cached content of a subscribed library to be
|
|||
|
|
removed to free up storage capacity. This method will only work when a
|
|||
|
|
subscribed library is synchronized on-demand.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a subscribed
|
|||
|
|
library.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>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>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>library_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns a given subscribed library.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryModel</span></code></a></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the library associated with <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code>
|
|||
|
|
if the library associated with <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a subscribed
|
|||
|
|
library.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>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>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.list">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.list" title="com.vmware.content_client.SubscribedLibrary.list"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.list" title="com.vmware.content_client.SubscribedLibrary.list"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.probe">
|
|||
|
|
<code class="descname">probe</code><span class="sig-paren">(</span><em>subscription_info</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.probe" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Probes remote library subscription information, including URL, SSL
|
|||
|
|
certificate and password. The resulting
|
|||
|
|
<a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult" title="com.vmware.content_client.SubscribedLibrary.ProbeResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubscribedLibrary.ProbeResult</span></code></a> class describes whether or not
|
|||
|
|
the subscription configuration is successful.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>subscription_info</strong> (<a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.SubscriptionInfo" title="com.vmware.content.library_client.SubscriptionInfo"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.SubscribedLibrary.ProbeResult" title="com.vmware.content_client.SubscribedLibrary.ProbeResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubscribedLibrary.ProbeResult</span></code></a></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The subscription info probe result.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">ContentLibrary.ProbeSubscription</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.sync">
|
|||
|
|
<code class="descname">sync</code><span class="sig-paren">(</span><em>library_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.sync" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Forces the synchronization of the subscribed library.</p>
|
|||
|
|
<p>Synchronizing a subscribed library forcefully with this method will
|
|||
|
|
perform the same synchronization behavior as would run periodically for
|
|||
|
|
the library. The
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.SubscriptionInfo.on_demand</span></code>
|
|||
|
|
setting is respected. Calling this method on a library that is already
|
|||
|
|
in the process of synchronizing will have no effect.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_id</strong> (<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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a subscribed
|
|||
|
|
library.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if some parameter in the subscribed library subscription info is
|
|||
|
|
invalid.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
if the published library cannot be contacted or found.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>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>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.SubscribedLibrary.update">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>library_id</em>, <em>update_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.SubscribedLibrary.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Updates the properties of a subscribed library.</p>
|
|||
|
|
<p>This is an incremental update to the subscribed library. Attributes
|
|||
|
|
that are None in the update specification will be left unchanged.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>library_id</strong> (<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>.</li>
|
|||
|
|
<li><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.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code>
|
|||
|
|
if the library specified by <code class="docutils literal notranslate"><span class="pre">library_id</span></code> is not a subscribed
|
|||
|
|
library.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is not valid.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
if the subscription info is being updated but the published library
|
|||
|
|
cannot be contacted or found.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ConcurrentChange</span></code>
|
|||
|
|
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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>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>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.Type">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content_client.</code><code class="descname">Type</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Type" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Type</span></code> class exposes the
|
|||
|
|
<a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.ItemModel</span></code></a> types that this
|
|||
|
|
Content Library Service supports.</p>
|
|||
|
|
<p>A library item has an optional type which can be specified with the
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.ItemModel.type</span></code> attribute. For
|
|||
|
|
items with a type that is supported by a plugin, the Content Library
|
|||
|
|
Service may understand the files which are part of the library item and can
|
|||
|
|
produce metadata for the item.</p>
|
|||
|
|
<p>In other cases, uploads may require a process in which one upload implies
|
|||
|
|
subsequent uploads. For example, an Open Virtualization Format (OVF)
|
|||
|
|
package is composed of an OVF descriptor file and the associated virtual
|
|||
|
|
disk files. Uploading an OVF descriptor can enable the Content Library
|
|||
|
|
Service to understand that the complete OVF package requires additional
|
|||
|
|
disk files, and it can set up the transfers for the disks automatically by
|
|||
|
|
adding the file entries for the disks when the OVF descriptor is uploaded.</p>
|
|||
|
|
<p>When a type is not supported by a plugin, or the type is not specified, the
|
|||
|
|
Content Library Service can handle a library item in a default way, without
|
|||
|
|
adding metadata to the item or guiding the upload process.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content_client.Type.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>description=None</em>, <em>name=None</em>, <em>type=None</em>, <em>vendor=None</em>, <em>version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content_client.Type.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Type.Info</span></code> class describes support for a specific type of data in an
|
|||
|
|
<a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.ItemModel</span></code></a>. The <code class="docutils literal notranslate"><span class="pre">Type.Info</span></code> can
|
|||
|
|
be queried through the <a class="reference internal" href="#com.vmware.content_client.Type" title="com.vmware.content_client.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a> class. Type support describes plugins
|
|||
|
|
in the Content Library which can provide metadata on library items and help
|
|||
|
|
manage the transfer process by adding dependent files when a current file
|
|||
|
|
is added.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content_client.Type.list">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content_client.Type.list" title="com.vmware.content_client.Type.list"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content_client.Type.list" title="com.vmware.content_client.Type.list"><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>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">ContentLibrary.TypeIntrospection</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.vcenter_client">
|
|||
|
|
<span id="com-vmware-vcenter-client-module"></span><h2>com.vmware.vcenter_client module<a class="headerlink" href="#module-com.vmware.vcenter_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter_client</span></code> module provides classes for managing VMware
|
|||
|
|
vSphere environments. The module is available starting in vSphere 6.5.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Cluster">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter_client.</code><code class="descname">Cluster</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Cluster" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster</span></code> class provides methods to manage clusters in the vCenter
|
|||
|
|
Server.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Cluster.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>clusters=None</em>, <em>names=None</em>, <em>folders=None</em>, <em>datacenters=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.FilterSpec</span></code> class contains attributes used to filter the
|
|||
|
|
results when listing clusters (see <a class="reference internal" href="#com.vmware.vcenter_client.Cluster.list" title="com.vmware.vcenter_client.Cluster.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Cluster.list()</span></code></a>). If multiple
|
|||
|
|
attributes are specified, only clusters matching all of the attributes
|
|||
|
|
match the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Cluster.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>name=None</em>, <em>resource_pool=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.Info</span></code> class contains information about a cluster in vCenter
|
|||
|
|
Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Cluster.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'ClusterComputeResource'</em><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The resource type for the vCenter Cluster</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Cluster.Summary">
|
|||
|
|
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>cluster=None</em>, <em>name=None</em>, <em>ha_enabled=None</em>, <em>drs_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.Summary</span></code> class contains commonly used information about a
|
|||
|
|
cluster in vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Cluster.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>cluster</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Retrieves information about the cluster corresponding to <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cluster</strong> (<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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Cluster.Info" title="com.vmware.vcenter_client.Cluster.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.Info</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.vcenter_client.Cluster.Info" title="com.vmware.vcenter_client.Cluster.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.Info</span></code></a> instances that corresponds to the
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">cluster</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the session id is missing from the request or the corresponding
|
|||
|
|
session object cannot be found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t not have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Cluster.list">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Cluster.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
|||
|
|
checks) clusters in vCenter matching the <a class="reference internal" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="com.vmware.vcenter_client.Cluster.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.FilterSpec</span></code></a>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="com.vmware.vcenter_client.Cluster.FilterSpec"><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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Cluster.list" title="com.vmware.vcenter_client.Cluster.list"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the clusters matching the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Cluster.FilterSpec" title="com.vmware.vcenter_client.Cluster.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.FilterSpec</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter_client.</code><code class="descname">Datacenter</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datacenter</span></code> class provides methods to manage datacenters in the
|
|||
|
|
vCenter Server.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>name=None</em>, <em>folder=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datacenter.CreateSpec</span></code> class defines the information used to create
|
|||
|
|
a datacenter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>datacenters=None</em>, <em>names=None</em>, <em>folders=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datacenter.FilterSpec</span></code> class contains attributes used to filter the
|
|||
|
|
results when listing datacenters (see <a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.list" title="com.vmware.vcenter_client.Datacenter.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Datacenter.list()</span></code></a>). If multiple
|
|||
|
|
attributes are specified, only datacenters matching all of the attributes
|
|||
|
|
match the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>name=None</em>, <em>datastore_folder=None</em>, <em>host_folder=None</em>, <em>network_folder=None</em>, <em>vm_folder=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datacenter.Info</span></code> class contains information about a datacenter in
|
|||
|
|
vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'Datacenter'</em><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The resource type for the vCenter Datacenter</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.Summary">
|
|||
|
|
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>datacenter=None</em>, <em>name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datacenter.Summary</span></code> class contains commonly used information about a
|
|||
|
|
datacenter in vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.create">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Create a new datacenter in the vCenter inventory</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.CreateSpec" title="com.vmware.vcenter_client.Datacenter.CreateSpec"><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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The identifier of the newly created datacenter
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Datacenter</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if the system reports an error while responding to the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code>
|
|||
|
|
if the datacenter with the same name is already present.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the datacenter name is empty or invalid as per the underlying
|
|||
|
|
implementation.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the folder is not specified and the system cannot choose a
|
|||
|
|
suitable one.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the datacenter folder cannot be found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.delete">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>datacenter</em>, <em>force=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Delete an empty datacenter from the vCenter Server</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>datacenter</strong> (<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>.</li>
|
|||
|
|
<li><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 <code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code>
|
|||
|
|
exception will be reported if the datacenter is not empty. This is
|
|||
|
|
the equivalent of passing the value false.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if there is no datacenter associated with <code class="docutils literal notranslate"><span class="pre">datacenter</span></code> in the
|
|||
|
|
system.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code>
|
|||
|
|
if the datacenter associated with <code class="docutils literal notranslate"><span class="pre">datacenter</span></code> is not empty.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>datacenter</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Retrieves information about the datacenter corresponding to
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">datacenter</span></code>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datacenter</strong> (<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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.Info" title="com.vmware.vcenter_client.Datacenter.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.Info</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.Info" title="com.vmware.vcenter_client.Datacenter.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.Info</span></code></a> instances that corresponds to the
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">datacenter</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if the system reports an error while responding to the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if there is no datacenter associated with <code class="docutils literal notranslate"><span class="pre">datacenter</span></code> in the
|
|||
|
|
system.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datacenter.list">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datacenter.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
|||
|
|
checks) datacenters in vCenter matching the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="com.vmware.vcenter_client.Datacenter.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.FilterSpec</span></code></a>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="com.vmware.vcenter_client.Datacenter.FilterSpec"><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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.list" title="com.vmware.vcenter_client.Datacenter.list"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the datacenters matching the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datacenter.FilterSpec" title="com.vmware.vcenter_client.Datacenter.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datacenter.FilterSpec</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter_client.</code><code class="descname">Datastore</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datastore" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The Datastore class provides methods for manipulating a datastore.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>datastores=None</em>, <em>names=None</em>, <em>types=None</em>, <em>folders=None</em>, <em>datacenters=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datastore.FilterSpec</span></code> class contains attributes used to filter the
|
|||
|
|
results when listing datastores (see <a class="reference internal" href="#com.vmware.vcenter_client.Datastore.list" title="com.vmware.vcenter_client.Datastore.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Datastore.list()</span></code></a>). If multiple
|
|||
|
|
attributes are specified, only datastores matching all of the attributes
|
|||
|
|
match the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>name=None</em>, <em>type=None</em>, <em>accessible=None</em>, <em>free_space=None</em>, <em>multiple_host_access=None</em>, <em>thin_provisioning_supported=None</em><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="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'Datastore'</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The resource type for the vCenter datastore</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Summary">
|
|||
|
|
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>datastore=None</em>, <em>name=None</em>, <em>type=None</em>, <em>free_space=None</em>, <em>capacity=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datastore.Summary</span></code> class contains commonly used information about a
|
|||
|
|
datastore.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type">
|
|||
|
|
<em class="property">class </em><code class="descname">Type</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Datastore.Type</span></code> class defines the supported types of vCenter
|
|||
|
|
datastores.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.CIFS">
|
|||
|
|
<code class="descname">CIFS</code><em class="property"> = Type(string='CIFS')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.CIFS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Common Internet File System.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.NFS">
|
|||
|
|
<code class="descname">NFS</code><em class="property"> = Type(string='NFS')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.NFS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Network file system v3 (linux & esx servers only).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.NFS41">
|
|||
|
|
<code class="descname">NFS41</code><em class="property"> = Type(string='NFS41')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.NFS41" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Network file system v4.1 (linux & esx servers only).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.VFFS">
|
|||
|
|
<code class="descname">VFFS</code><em class="property"> = Type(string='VFFS')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.VFFS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Flash Read Cache (ESX Server only).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.VMFS">
|
|||
|
|
<code class="descname">VMFS</code><em class="property"> = Type(string='VMFS')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.VMFS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>VMware File System (ESX Server only).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.VSAN">
|
|||
|
|
<code class="descname">VSAN</code><em class="property"> = Type(string='VSAN')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.VSAN" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Virtual SAN (ESX Server only).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.Type.VVOL">
|
|||
|
|
<code class="descname">VVOL</code><em class="property"> = Type(string='VVOL')</em><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.Type.VVOL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>vSphere Virtual Volume (ESX Server only).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>datastore</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Retrieves information about the datastore indicated by <code class="docutils literal notranslate"><span class="pre">datastore</span></code>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datastore</strong> (<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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Datastore.Info" title="com.vmware.vcenter_client.Datastore.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.Info</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">information about the datastore.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the datastore indicated by <code class="docutils literal notranslate"><span class="pre">datastore</span></code> does not exist.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Datastore.list">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Datastore.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
|||
|
|
checks) datastores in vCenter matching the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="com.vmware.vcenter_client.Datastore.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.FilterSpec</span></code></a>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="com.vmware.vcenter_client.Datastore.FilterSpec"><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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Datastore.list" title="com.vmware.vcenter_client.Datastore.list"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the datastores matching the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="com.vmware.vcenter_client.Datastore.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.FilterSpec</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
if more than 1000 datastores match the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Datastore.FilterSpec" title="com.vmware.vcenter_client.Datastore.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.FilterSpec</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Deployment">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter_client.</code><code class="descname">Deployment</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Deployment" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Deployment</span></code> class provides methods to get the status of the vCenter
|
|||
|
|
appliance deployment. This class was added in vSphere API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Deployment.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>state=None</em>, <em>progress=None</em>, <em>subtask_order=None</em>, <em>subtasks=None</em>, <em>description=None</em>, <em>service=None</em>, <em>operation=None</em>, <em>parent=None</em>, <em>target=None</em>, <em>status=None</em>, <em>cancelable=None</em>, <em>error=None</em>, <em>start_time=None</em>, <em>end_time=None</em>, <em>user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Deployment.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Deployment.Info</span></code> class contains attributes to describe the state of
|
|||
|
|
the appliance. This class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Deployment.Task">
|
|||
|
|
<em class="property">class </em><code class="descname">Task</code><span class="sig-paren">(</span><em>progress=None</em>, <em>result=None</em>, <em>description=None</em>, <em>service=None</em>, <em>operation=None</em>, <em>parent=None</em>, <em>target=None</em>, <em>status=None</em>, <em>cancelable=None</em>, <em>error=None</em>, <em>start_time=None</em>, <em>end_time=None</em>, <em>user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Deployment.Task" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Deployment.Task</span></code> class contains attributes to describe a particular
|
|||
|
|
deployment task. This class was added in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Deployment.get">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Info structure containing the status information about the
|
|||
|
|
appliance.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the caller is not authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if appliance state cannot be determined.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Deployment.rollback">
|
|||
|
|
<code class="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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code>
|
|||
|
|
if the appliance is not in FAILED state.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the caller is not authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter_client.</code><code class="descname">Folder</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Folder" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The Folder class provides methods for manipulating a vCenter Server folder.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>folders=None</em>, <em>names=None</em>, <em>type=None</em>, <em>parent_folders=None</em>, <em>datacenters=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Folder.FilterSpec</span></code> class contains attributes used to filter the
|
|||
|
|
results when listing folders (see <a class="reference internal" href="#com.vmware.vcenter_client.Folder.list" title="com.vmware.vcenter_client.Folder.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Folder.list()</span></code></a>). If multiple
|
|||
|
|
attributes are specified, only folders matching all of the attributes match
|
|||
|
|
the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'Folder'</em><a class="headerlink" href="#com.vmware.vcenter_client.Folder.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The resource type for the vCenter folder</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.Summary">
|
|||
|
|
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>folder=None</em>, <em>name=None</em>, <em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Folder.Summary</span></code> class contains commonly used information about a
|
|||
|
|
folder.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type">
|
|||
|
|
<em class="property">class </em><code class="descname">Type</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Folder.Type</span></code> class defines the type of a vCenter Server folder. The
|
|||
|
|
type of a folder determines what what kinds of children can be contained in
|
|||
|
|
the folder.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type.DATACENTER">
|
|||
|
|
<code class="descname">DATACENTER</code><em class="property"> = Type(string='DATACENTER')</em><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type.DATACENTER" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>A folder that can contain datacenters.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type.DATASTORE">
|
|||
|
|
<code class="descname">DATASTORE</code><em class="property"> = Type(string='DATASTORE')</em><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type.DATASTORE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>A folder that can contain datastores.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type.HOST">
|
|||
|
|
<code class="descname">HOST</code><em class="property"> = Type(string='HOST')</em><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type.HOST" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>A folder that can contain compute resources (hosts and clusters).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type.NETWORK">
|
|||
|
|
<code class="descname">NETWORK</code><em class="property"> = Type(string='NETWORK')</em><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type.NETWORK" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>A folder that can contain networkds.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.Type.VIRTUAL_MACHINE">
|
|||
|
|
<code class="descname">VIRTUAL_MACHINE</code><em class="property"> = Type(string='VIRTUAL_MACHINE')</em><a class="headerlink" href="#com.vmware.vcenter_client.Folder.Type.VIRTUAL_MACHINE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>A folder that can contain virtual machines.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Folder.list">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Folder.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
|||
|
|
checks) folders in vCenter matching the <a class="reference internal" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="com.vmware.vcenter_client.Folder.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Folder.FilterSpec</span></code></a>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="com.vmware.vcenter_client.Folder.FilterSpec"><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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Folder.list" title="com.vmware.vcenter_client.Folder.list"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the folders matching the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Folder.FilterSpec" title="com.vmware.vcenter_client.Folder.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Folder.FilterSpec</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter_client.</code><code class="descname">Host</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Host</span></code> class provides methods to manage hosts in the vCenter Server.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.ConnectionState">
|
|||
|
|
<em class="property">class </em><code class="descname">ConnectionState</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.ConnectionState" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Host.ConnectionState</span></code> class defines the connection status of a host.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.ConnectionState.CONNECTED">
|
|||
|
|
<code class="descname">CONNECTED</code><em class="property"> = ConnectionState(string='CONNECTED')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.ConnectionState.CONNECTED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Host is connected to the vCenter Server</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.ConnectionState.DISCONNECTED">
|
|||
|
|
<code class="descname">DISCONNECTED</code><em class="property"> = ConnectionState(string='DISCONNECTED')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.ConnectionState.DISCONNECTED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Host is disconnected from the vCenter Server</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.ConnectionState.NOT_RESPONDING">
|
|||
|
|
<code class="descname">NOT_RESPONDING</code><em class="property"> = ConnectionState(string='NOT_RESPONDING')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.ConnectionState.NOT_RESPONDING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>VirtualCenter is not receiving heartbeats from the server. The state
|
|||
|
|
automatically changes to connected once heartbeats are received again.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>hostname=None</em>, <em>port=None</em>, <em>user_name=None</em>, <em>password=None</em>, <em>folder=None</em>, <em>thumbprint_verification=None</em>, <em>thumbprint=None</em>, <em>force_add=None</em><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="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification">
|
|||
|
|
<em class="property">class </em><code class="descname">ThumbprintVerification</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Host.CreateSpec.ThumbprintVerification</span></code> class defines the thumbprint
|
|||
|
|
verification schemes for a host’s SSL certificate.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.NONE">
|
|||
|
|
<code class="descname">NONE</code><em class="property"> = ThumbprintVerification(string='NONE')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.NONE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Accept the host’s thumbprint without verifying it.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.THUMBPRINT">
|
|||
|
|
<code class="descname">THUMBPRINT</code><em class="property"> = ThumbprintVerification(string='THUMBPRINT')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.THUMBPRINT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Host’s SSL certificate verified by checking its thumbprint against the
|
|||
|
|
specified thumbprint.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>hosts=None</em>, <em>names=None</em>, <em>folders=None</em>, <em>datacenters=None</em>, <em>standalone=None</em>, <em>clusters=None</em>, <em>connection_states=None</em><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="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.PowerState">
|
|||
|
|
<em class="property">class </em><code class="descname">PowerState</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.PowerState" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Host.PowerState</span></code> class defines the power states of a host.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.PowerState.POWERED_OFF">
|
|||
|
|
<code class="descname">POWERED_OFF</code><em class="property"> = PowerState(string='POWERED_OFF')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.PowerState.POWERED_OFF" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The host was specifically powered off by the user through vCenter server.
|
|||
|
|
This state is not a cetain state, because after vCenter server issues the
|
|||
|
|
command to power off the host, the host might crash, or kill all the
|
|||
|
|
processes but fail to power off.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.PowerState.POWERED_ON">
|
|||
|
|
<code class="descname">POWERED_ON</code><em class="property"> = PowerState(string='POWERED_ON')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.PowerState.POWERED_ON" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The host is powered on. A host that is entering standby mode is also in
|
|||
|
|
this state.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.PowerState.STANDBY">
|
|||
|
|
<code class="descname">STANDBY</code><em class="property"> = PowerState(string='STANDBY')</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.PowerState.STANDBY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The host was specifically put in standby mode, either explicitly by the
|
|||
|
|
user, or automatically by DPM. This state is not a cetain state, because
|
|||
|
|
after VirtualCenter issues the command to put the host in standby state,
|
|||
|
|
the host might crash, or kill all the processes but fail to enter standby
|
|||
|
|
mode. A host that is exiting standby mode is also in this state.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'HostSystem'</em><a class="headerlink" href="#com.vmware.vcenter_client.Host.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The resource type for the vCenter Host.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.Summary">
|
|||
|
|
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>host=None</em>, <em>name=None</em>, <em>connection_state=None</em>, <em>power_state=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Host.Summary</span></code> class contains commonly used information about a host
|
|||
|
|
in vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.connect">
|
|||
|
|
<code class="descname">connect</code><span class="sig-paren">(</span><em>host</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.connect" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Connect to the host corresponding to <code class="docutils literal notranslate"><span class="pre">host</span></code> previously added to the
|
|||
|
|
vCenter server.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>host</strong> (<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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
if the host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> is already connected.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if the system reports an error while responding to the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if there is no host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> in the system.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.create">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Add a new standalone host in the vCenter inventory. The newly connected
|
|||
|
|
host will be in connected state. The vCenter Server will verify the SSL
|
|||
|
|
certificate before adding the host to its inventory. In the case where
|
|||
|
|
the SSL certificate cannot be verified because the Certificate
|
|||
|
|
Authority is not recognized or the certificate is self signed, the
|
|||
|
|
vCenter Server will fall back to thumbprint verification mode as
|
|||
|
|
defined by <a class="reference internal" href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification" title="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.CreateSpec.ThumbprintVerification</span></code></a>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Host.CreateSpec" title="com.vmware.vcenter_client.Host.CreateSpec"><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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The newly created identifier of the host in vCenter.
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code>
|
|||
|
|
if the host with the same name is already present.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if installation of VirtualCenter agent on a host fails.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if the system reports an error while responding to the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the host name is invalid.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the host folder is invalid.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the SSL thumbprint specified is invalid.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code>
|
|||
|
|
if the host folder id does not support vSphere compute resource as
|
|||
|
|
its children type.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if there is no folder associated with the <code class="docutils literal notranslate"><span class="pre">folder</span></code> attribute in
|
|||
|
|
the system.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code>
|
|||
|
|
if the host is already being managed by another vCenter Server</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
if there are not enough licenses to add the host.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user name or password for the administration account on the
|
|||
|
|
host are invalid.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code>
|
|||
|
|
if the software version on the host is not supported.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.delete">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>host</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Remove a standalone host from the vCenter Server.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>host</strong> (<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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if the system reports an error while responding to the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if there is no host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> in the system.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code>
|
|||
|
|
if the host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> is in a vCenter cluster</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.disconnect">
|
|||
|
|
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>host</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.disconnect" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Disconnect the host corresponding to <code class="docutils literal notranslate"><span class="pre">host</span></code> from the vCenter server</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>host</strong> (<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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
if the host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> is already disconnected.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if the system reports an error while responding to the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if there is no host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> in the system.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Host.list">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Host.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
|||
|
|
checks) hosts in vCenter matching the <a class="reference internal" href="#com.vmware.vcenter_client.Host.FilterSpec" title="com.vmware.vcenter_client.Host.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.FilterSpec</span></code></a>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Host.FilterSpec" title="com.vmware.vcenter_client.Host.FilterSpec"><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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Host.list" title="com.vmware.vcenter_client.Host.list"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the hosts matching the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Host.FilterSpec" title="com.vmware.vcenter_client.Host.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.FilterSpec</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
if more than 1000 hosts match the <a class="reference internal" href="#com.vmware.vcenter_client.Host.FilterSpec" title="com.vmware.vcenter_client.Host.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Host.FilterSpec</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter_client.</code><code class="descname">Network</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Network" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The Network class provides methods for manipulating a vCenter Server
|
|||
|
|
network.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>networks=None</em>, <em>names=None</em>, <em>types=None</em>, <em>folders=None</em>, <em>datacenters=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Network.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Network.FilterSpec</span></code> class contains attributes used to filter the
|
|||
|
|
results when listing networks (see <a class="reference internal" href="#com.vmware.vcenter_client.Network.list" title="com.vmware.vcenter_client.Network.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Network.list()</span></code></a>). If multiple
|
|||
|
|
attributes are specified, only networks matching all of the attributes
|
|||
|
|
match the filter.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'Network'</em><a class="headerlink" href="#com.vmware.vcenter_client.Network.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The resource type for the vCenter network</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network.Summary">
|
|||
|
|
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>network=None</em>, <em>name=None</em>, <em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Network.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Network.Summary</span></code> class contains commonly used information about a
|
|||
|
|
network.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network.Type">
|
|||
|
|
<em class="property">class </em><code class="descname">Type</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Network.Type" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Network.Type</span></code> class defines the type of a vCenter Server network.
|
|||
|
|
The type of a network can be used to determine what features it supports
|
|||
|
|
and which APIs can be used to find more information about the network or
|
|||
|
|
change its configuration.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network.Type.DISTRIBUTED_PORTGROUP">
|
|||
|
|
<code class="descname">DISTRIBUTED_PORTGROUP</code><em class="property"> = Type(string='DISTRIBUTED_PORTGROUP')</em><a class="headerlink" href="#com.vmware.vcenter_client.Network.Type.DISTRIBUTED_PORTGROUP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>XXX: vCenter based (create and managed through vCenter)</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network.Type.OPAQUE_NETWORK">
|
|||
|
|
<code class="descname">OPAQUE_NETWORK</code><em class="property"> = Type(string='OPAQUE_NETWORK')</em><a class="headerlink" href="#com.vmware.vcenter_client.Network.Type.OPAQUE_NETWORK" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>A network for whose configuration is managed outside of vSphere. The
|
|||
|
|
identifer and name of the network is made available through vSphere so that
|
|||
|
|
host and virtual machine virtual ethernet devices can connect to them.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network.Type.STANDARD_PORTGROUP">
|
|||
|
|
<code class="descname">STANDARD_PORTGROUP</code><em class="property"> = Type(string='STANDARD_PORTGROUP')</em><a class="headerlink" href="#com.vmware.vcenter_client.Network.Type.STANDARD_PORTGROUP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>XXX: ESX based (created and managed on ESX)</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.Network.list">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.Network.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
|||
|
|
checks) networks in vCenter matching the <a class="reference internal" href="#com.vmware.vcenter_client.Network.FilterSpec" title="com.vmware.vcenter_client.Network.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.FilterSpec</span></code></a>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.Network.FilterSpec" title="com.vmware.vcenter_client.Network.FilterSpec"><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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.Network.list" title="com.vmware.vcenter_client.Network.list"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the networks matching the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.Network.FilterSpec" title="com.vmware.vcenter_client.Network.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.FilterSpec</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter_client.</code><code class="descname">ResourcePool</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The ResourcePool class provides methods for manipulating a vCenter Server
|
|||
|
|
resource pool.</p>
|
|||
|
|
<p>This class does not include virtual appliances in the inventory of resource
|
|||
|
|
pools even though part of the behavior of a virtual appliance is to act
|
|||
|
|
like a resource pool.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>resource_pools=None</em>, <em>names=None</em>, <em>parent_resource_pools=None</em>, <em>datacenters=None</em>, <em>hosts=None</em>, <em>clusters=None</em><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="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>name=None</em>, <em>resource_pools=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ResourcePool.Info</span></code> class contains information about a resource pool.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'ResourcePool'</em><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The resource type for the vCenter resource pool</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.Summary">
|
|||
|
|
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>resource_pool=None</em>, <em>name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ResourcePool.Summary</span></code> class contains commonly used information about
|
|||
|
|
a resource pool in vCenter Server.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>resource_pool</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Retrieves information about the resource pool indicated by
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">resource_pool</span></code>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>resource_pool</strong> (<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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.Info" title="com.vmware.vcenter_client.ResourcePool.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.Info</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">information about the resource pool.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the resource pool indicated by <code class="docutils literal notranslate"><span class="pre">resource_pool</span></code> does not exist.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.ResourcePool.list">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.ResourcePool.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
|||
|
|
checks) resource pools in vCenter matching the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.FilterSpec" title="com.vmware.vcenter_client.ResourcePool.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.FilterSpec</span></code></a>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.FilterSpec" title="com.vmware.vcenter_client.ResourcePool.FilterSpec"><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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.list" title="com.vmware.vcenter_client.ResourcePool.list"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the resource pools matching the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.ResourcePool.FilterSpec" title="com.vmware.vcenter_client.ResourcePool.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool.FilterSpec</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter_client.</code><code class="descname">VM</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM</span></code> class provides methods for managing the lifecycle of a virtual
|
|||
|
|
machine.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>guest_os=None</em>, <em>name=None</em>, <em>placement=None</em>, <em>hardware_version=None</em>, <em>boot=None</em>, <em>boot_devices=None</em>, <em>cpu=None</em>, <em>memory=None</em>, <em>disks=None</em>, <em>nics=None</em>, <em>cdroms=None</em>, <em>floppies=None</em>, <em>parallel_ports=None</em>, <em>serial_ports=None</em>, <em>sata_adapters=None</em>, <em>scsi_adapters=None</em>, <em>storage_policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Document-based creation spec.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.FilterSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>vms=None</em>, <em>names=None</em>, <em>folders=None</em>, <em>datacenters=None</em>, <em>hosts=None</em>, <em>clusters=None</em>, <em>resource_pools=None</em>, <em>power_states=None</em><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="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>guest_os=None</em>, <em>name=None</em>, <em>power_state=None</em>, <em>hardware=None</em>, <em>boot=None</em>, <em>boot_devices=None</em>, <em>cpu=None</em>, <em>memory=None</em>, <em>disks=None</em>, <em>nics=None</em>, <em>cdroms=None</em>, <em>floppies=None</em>, <em>parallel_ports=None</em>, <em>serial_ports=None</em>, <em>sata_adapters=None</em>, <em>scsi_adapters=None</em><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="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.PlacementSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">PlacementSpec</code><span class="sig-paren">(</span><em>folder=None</em>, <em>resource_pool=None</em>, <em>host=None</em>, <em>cluster=None</em>, <em>datastore=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.PlacementSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.PlacementSpec</span></code> class contains information used to place a virtual
|
|||
|
|
machine onto resources within the vCenter inventory.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.StoragePolicySpec">
|
|||
|
|
<em class="property">class </em><code class="descname">StoragePolicySpec</code><span class="sig-paren">(</span><em>policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.StoragePolicySpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.StoragePolicySpec</span></code> class contains information about the storage
|
|||
|
|
policy to be associated with a virtual machine object. This class was added
|
|||
|
|
in vSphere API 6.7</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.Summary">
|
|||
|
|
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>vm=None</em>, <em>name=None</em>, <em>power_state=None</em>, <em>cpu_count=None</em>, <em>memory_size_mib=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">VM.Summary</span></code> class contains commonly used information about a virtual
|
|||
|
|
machine.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.create">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Creates a virtual machine.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.CreateSpec" title="com.vmware.vcenter_client.VM.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.CreateSpec</span></code></a>) – Virtual machine specification.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">ID of newly-created virtual machine.
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code>
|
|||
|
|
if a virtual machine with the specified name already exists.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if the system reports an error while responding to the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if any of the specified parameters are invalid.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if any of the resources specified in spec could not be found</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
if a specified resource (eg. host) is not accessible.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code>
|
|||
|
|
if any of the specified storage addresses (eg. IDE, SATA, SCSI)
|
|||
|
|
result in a storage address conflict.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
if any of the resources needed to create the virtual machine could
|
|||
|
|
not be allocated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code>
|
|||
|
|
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.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.delete">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Deletes a virtual machine.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm</strong> (<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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if the system reports an error while responding to the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if the virtual machine is running (powered on).</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
if the virtual machine is busy performing another operation.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about a virtual machine.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm</strong> (<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>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.VM.Info" title="com.vmware.vcenter_client.VM.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Info</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Information about the specified virtual machine.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
if the system reports an error while responding to the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter_client.VM.list">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter_client.VM.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about at most 1000 visible (subject to permission
|
|||
|
|
checks) virtual machines in vCenter matching the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.VM.FilterSpec" title="com.vmware.vcenter_client.VM.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a>.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter_client.VM.FilterSpec" title="com.vmware.vcenter_client.VM.FilterSpec"><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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter_client.VM.list" title="com.vmware.vcenter_client.VM.list"><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></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Commonly used information about the virtual machines matching the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.VM.FilterSpec" title="com.vmware.vcenter_client.VM.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
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.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
if more than 1000 virtual machines match the
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter_client.VM.FilterSpec" title="com.vmware.vcenter_client.VM.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="articleComments">
|
|||
|
|
|
|||
|
|
</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" title="com package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
© Copyright 2018, VMware, Inc..
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
var DOCUMENTATION_OPTIONS = {
|
|||
|
|
URL_ROOT:'./',
|
|||
|
|
VERSION:'6.7.0',
|
|||
|
|
COLLAPSE_INDEX:false,
|
|||
|
|
FILE_SUFFIX:'.html',
|
|||
|
|
HAS_SOURCE: true,
|
|||
|
|
SOURCELINK_SUFFIX: '.txt'
|
|||
|
|
};
|
|||
|
|
</script>
|
|||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.StickyNav.enable();
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|