mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 01:39:58 -05:00
44eb68437b
Signed-off-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com> Co-authored-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>
962 lines
97 KiB
HTML
962 lines
97 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>com.vmware.snapservice.clusters package — vSphere Automation SDK for Python. 8.0.3.0 documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/sphinx_highlight.js"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="com.vmware.snapservice.clusters.virtual_machines package" href="com.vmware.snapservice.clusters.virtual_machines.html" />
|
||
<link rel="prev" title="com.vmware.snapservice package" href="com.vmware.snapservice.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home">
|
||
vSphere Automation SDK for Python.
|
||
</a>
|
||
<div class="version">
|
||
8.0.3.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" aria-label="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="Navigation menu">
|
||
<p class="caption" role="heading"><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="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.esx_client">com.vmware.esx_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.snapservice_client">com.vmware.snapservice_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<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="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
|
||
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
|
||
<li class="breadcrumb-item"><a href="com.vmware.snapservice.html">com.vmware.snapservice package</a></li>
|
||
<li class="breadcrumb-item active">com.vmware.snapservice.clusters package</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/com.vmware.snapservice.clusters.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">
|
||
|
||
<section id="module-com.vmware.snapservice.clusters">
|
||
<span id="com-vmware-snapservice-clusters-package"></span><h1>com.vmware.snapservice.clusters package<a class="headerlink" href="#module-com.vmware.snapservice.clusters" title="Permalink to this heading"></a></h1>
|
||
<section id="subpackages">
|
||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.snapservice.clusters.virtual_machines.html">com.vmware.snapservice.clusters.virtual_machines package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.snapservice.clusters.virtual_machines.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.snapservice.clusters.virtual_machines.html#module-com.vmware.snapservice.clusters.virtual_machines.disks_client">com.vmware.snapservice.clusters.virtual_machines.disks_client module</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.snapservice.clusters.virtual_machines.html#com.vmware.snapservice.clusters.virtual_machines.disks_client.Snapshots"><code class="docutils literal notranslate"><span class="pre">Snapshots</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.snapservice.clusters.virtual_machines.html#com.vmware.snapservice.clusters.virtual_machines.disks_client.Snapshots.Info"><code class="docutils literal notranslate"><span class="pre">Snapshots.Info</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.snapservice.clusters.virtual_machines.html#com.vmware.snapservice.clusters.virtual_machines.disks_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||
</section>
|
||
<section id="module-com.vmware.snapservice.clusters.protection_groups_client">
|
||
<span id="com-vmware-snapservice-clusters-protection-groups-client-module"></span><h2>com.vmware.snapservice.clusters.protection_groups_client module<a class="headerlink" href="#module-com.vmware.snapservice.clusters.protection_groups_client" title="Permalink to this heading"></a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.clusters.protection_groups_client</span></code> module
|
||
provides classes for managing protection groups in a vSAN cluster.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.snapservice.clusters.protection_groups_client.</span></span><span class="sig-name descname"><span class="pre">Snapshots</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots</span></code> class provides methods to manage snapshots for a
|
||
protection group.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.CreateResult">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CreateResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">snapshot_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">total_vms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">successful_vms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failed_vms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">snapshot</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.CreateResult" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots.CreateResult</span></code> class contains information regarding the
|
||
operation to create protection group snapshot.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>snapshot_type</strong> (<a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Type" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.Type</span></code></a>) – Type of the snapshot.</p></li>
|
||
<li><p><strong>total_vms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Total number of virtual machines considered for the snapshot
|
||
operation.</p></li>
|
||
<li><p><strong>successful_vms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of virtual machines that were successfully snapshotted.</p></li>
|
||
<li><p><strong>failed_vms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of virtual machines the system failed to create snapshots
|
||
for.</p></li>
|
||
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the snapshot policy this snapshot corresponds to.
|
||
None if the snapshot was not a scheduled snapshot.</p></li>
|
||
<li><p><strong>snapshot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the protection group snapshot.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group.snapshot</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group.snapshot</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.CreateSpec">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CreateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retention</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.CreateSpec" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots.CreateSpec</span></code> class contains attributes that describe
|
||
specification for creating a manual protection group snapshot.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the protection group snapshot.</p></li>
|
||
<li><p><strong>retention</strong> (<a class="reference internal" href="com.vmware.html#com.vmware.snapservice_client.RetentionPeriod" title="com.vmware.snapservice_client.RetentionPeriod"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.snapservice_client.RetentionPeriod</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Retention period for the snapshot. Indicates the duration for which
|
||
this snapshot must be retained in the system.
|
||
if None the snapshot will be retained till the life of the cluster
|
||
that the protection group belongs to or the life of the protection
|
||
group itself.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.FilterSpec">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expires_after</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expires_before</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created_after</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created_before</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">snapshots</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.FilterSpec" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots.FilterSpec</span></code> class contains attributes used to filter the
|
||
results when listing snapshots for a protection group. See
|
||
<a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.list" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Snapshots.list()</span></code></a>. When multiple filters are specified, it operates as
|
||
an AND operation. The snapshots returned will match all the specified
|
||
filters.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>expires_after</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Minimum expiration time for the snapshots that must match the
|
||
filter.
|
||
If None snapshots with any expiration time match the filter.</p></li>
|
||
<li><p><strong>expires_before</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum expiration time for the snapshots that must match the
|
||
filter.
|
||
If None snapshots with any expiration time match the filter.</p></li>
|
||
<li><p><strong>created_after</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Minimum creation date for the snapshots that must match the filter.
|
||
If None snapshots with any creation time match the filter.</p></li>
|
||
<li><p><strong>created_before</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum creation date for the snapshots that must match the filter.
|
||
If None snapshots with any creation time match the filter.</p></li>
|
||
<li><p><strong>snapshots</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers of the snapshots that must match the filter.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group.snapshot</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group.snapshot</span></code>.
|
||
If None snapshots with any identifier match the filter.</p></li>
|
||
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names of the snapshots that must match the filter.
|
||
If None snapshots with any name match the filter.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Info">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">snapshot_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expires_at</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_snapshots</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Info" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
||
<p>Information regarding a protection group snapshot.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Snapshot name. For a snapshot triggered by a periodic scchedule,
|
||
name will be system generated.</p></li>
|
||
<li><p><strong>snapshot_type</strong> (<a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Type" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.Type</span></code></a>) – Snapshot type.</p></li>
|
||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time at which the protection group snapshot operation started.</p></li>
|
||
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time at which the protection group snapshot operation completed.</p></li>
|
||
<li><p><strong>expires_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Expiry time.
|
||
None if there is no expiry for the snapshot.</p></li>
|
||
<li><p><strong>pg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the protection group for which the snapshot was
|
||
taken.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group</span></code>. When methods return a
|
||
value of this class as a return value, the attribute will be an
|
||
identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group</span></code>.</p></li>
|
||
<li><p><strong>vm_snapshots</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.VmSnapshotSummary" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.VmSnapshotSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.VmSnapshotSummary</span></code></a>) – List of virtual machine snapshots that were taken for this snapshot
|
||
instance.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.ListItem">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ListItem</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">snapshot</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.ListItem" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots.ListItem</span></code> class contains information about a protection
|
||
group snapshot returned by <a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.list" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Snapshots.list()</span></code></a> method</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>snapshot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the protection group snapshot.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group.snapshot</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group.snapshot</span></code>.</p></li>
|
||
<li><p><strong>info</strong> (<a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Info" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.Info</span></code></a>) – Information about the protection group snapshot.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.ListResult">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ListResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">snapshots</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.ListResult" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots.ListResult</span></code> class represents the result of
|
||
<a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.list" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Snapshots.list()</span></code></a> method.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>snapshots</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.ListItem" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.ListItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.ListItem</span></code></a>) – List of items.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Type">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Type" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots.Type</span></code> enumeration contains valid snapshot types.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Type.ONE_TIME">
|
||
<span class="sig-name descname"><span class="pre">ONE_TIME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='ONE_TIME')</span></em><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Type.ONE_TIME" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Indicates that the snapshot was taken as a one time operation triggered by
|
||
the user.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Type.SCHEDULED">
|
||
<span class="sig-name descname"><span class="pre">SCHEDULED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='SCHEDULED')</span></em><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Type.SCHEDULED" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Indicates that a snapshot was taken as part of a periodic schedule.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Type.SYSTEM_CREATED">
|
||
<span class="sig-name descname"><span class="pre">SYSTEM_CREATED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='SYSTEM_CREATED')</span></em><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Type.SYSTEM_CREATED" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Indicates that the snapshot was taken by the system</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.VmSnapshotSummary">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">VmSnapshotSummary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">snapshot</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created_at</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expires_at</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.VmSnapshotSummary" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots.VmSnapshotSummary</span></code> class contains commonly used
|
||
information about a virtual machine snapshot.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>snapshot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine snapshot.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.vm.snapshot</span></code>. When methods return a value
|
||
of this class as a return value, the attribute will be an
|
||
identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.vm.snapshot</span></code>.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Snapshot name. For a snapshot triggered by a periodic scchedule,
|
||
name will be system generated.</p></li>
|
||
<li><p><strong>created_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Creation time.</p></li>
|
||
<li><p><strong>expires_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Expiry time.
|
||
None if there is no expiry for the snapshot.</p></li>
|
||
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine for which the snapshot was taken.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.create_task">
|
||
<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.create_task" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Create a snapshot for the given protection group.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>pg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the protection group.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.CreateSpec" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.CreateSpec</span></code></a>) – specification for the protection group snapshot.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><dl class="field-list simple">
|
||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Task instance</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
If there is another operation in progress.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no protection
|
||
group associated with <code class="docutils literal notranslate"><span class="pre">pg</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
If validation of the <code class="docutils literal notranslate"><span class="pre">spec</span></code> fails.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
If the service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
If the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the caller is not authorized to perform the operation.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.delete">
|
||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">snapshot</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.delete" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Delete the specified protection group snapshot.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>pg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the protection group.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group</span></code>.</p></li>
|
||
<li><p><strong>snapshot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the protection group snapshot.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group.snapshot</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no protection group
|
||
associated with <code class="docutils literal notranslate"><span class="pre">pg</span></code> or no snapshot associated with <code class="docutils literal notranslate"><span class="pre">snapshot</span></code>
|
||
is found in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
If the service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
If the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the caller is not authorized to perform the operation.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.get">
|
||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">snapshot</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.get" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Get the detailed information regarding the specified protection group
|
||
snapshot.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>pg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the protection group.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group</span></code>.</p></li>
|
||
<li><p><strong>snapshot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the protection group snapshot.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group.snapshot</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Info" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Information about the specified protection group snapshot.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no protection group
|
||
associated with <code class="docutils literal notranslate"><span class="pre">pg</span></code> or no snapshot associated with <code class="docutils literal notranslate"><span class="pre">snapshot</span></code>
|
||
is found in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
If the service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
If the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the caller is not authorized to perform the operation.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.list">
|
||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.list" title="Permalink to this definition"></a></dt>
|
||
<dd><p>List the snapshots for the given protection group.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>pg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the protection group.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group</span></code>.</p></li>
|
||
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.FilterSpec" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of matching snapshots for which information should be
|
||
returned.
|
||
If None, the behavior is equivalent to a
|
||
<a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.FilterSpec" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.FilterSpec</span></code></a> with all attributes None which means
|
||
all protection group snapshots match the filter.
|
||
<a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.FilterSpec" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.FilterSpec</span></code></a> for the specified protection group.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.snapservice.clusters.protection_groups_client.Snapshots.ListResult" title="com.vmware.snapservice.clusters.protection_groups_client.Snapshots.ListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.ListResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Information about the snapshots matching the</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no or no
|
||
protection group associated with <a href="#id1"><span class="problematic" id="id2">``</span></a>pg``in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
If validation of the <code class="docutils literal notranslate"><span class="pre">filter</span></code> fails.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
If the service is not available.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
If the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the caller is not authorized to perform the operation.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.protection_groups_client.StubFactory">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.snapservice.clusters.protection_groups_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.protection_groups_client.StubFactory" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-com.vmware.snapservice.clusters.virtual_machines_client">
|
||
<span id="com-vmware-snapservice-clusters-virtual-machines-client-module"></span><h2>com.vmware.snapservice.clusters.virtual_machines_client module<a class="headerlink" href="#module-com.vmware.snapservice.clusters.virtual_machines_client" title="Permalink to this heading"></a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.clusters.virtual_machines_client</span></code> module provides
|
||
classes for managing virtual machines in a vSAN cluster.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.snapservice.clusters.virtual_machines_client.</span></span><span class="sig-name descname"><span class="pre">Snapshots</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots</span></code> class provides methods to manage snapshots for a
|
||
protection group.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.FilterSpec">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expires_after</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expires_before</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created_after</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created_before</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">snapshots</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">snapshot_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.FilterSpec" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots.FilterSpec</span></code> class contains attributes used to filter the
|
||
results when listing snapshots for a protection group. See
|
||
<a class="reference internal" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.list" title="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Snapshots.list()</span></code></a>. When multiple filters are specified, it operates as
|
||
an AND operation. The snapshots returned will match all the specified
|
||
filters.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>expires_after</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Minimum expiration time for the snapshots that must match the
|
||
filter.
|
||
If None snapshots with any expiration time match the filter.</p></li>
|
||
<li><p><strong>expires_before</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum expiration time for the snapshots that must match the
|
||
filter.
|
||
If None snapshots with any expiration time match the filter.</p></li>
|
||
<li><p><strong>created_after</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Minimum creation date for the snapshots that must match the filter.
|
||
If None snapshots with any creation time match the filter.</p></li>
|
||
<li><p><strong>created_before</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum creation date for the snapshots that must match the filter.
|
||
If None snapshots with any creation time match the filter.</p></li>
|
||
<li><p><strong>snapshots</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers of the snapshots that must match the filter.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.vm.snapshot</span></code>. When methods return a value
|
||
of this class as a return value, the attribute will contain
|
||
identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.vm.snapshot</span></code>.
|
||
If None snapshots with any identifier match the filter.</p></li>
|
||
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Names of the snapshots that must match the filter.
|
||
If None snapshots with any name match the filter.</p></li>
|
||
<li><p><strong>snapshot_type</strong> (<a class="reference internal" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Type" title="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.Type</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Snapshot type that must match the filter.
|
||
If None snapshots with any type match the filter.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Info">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">snapshot_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created_at</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expires_at</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disk_snapshots</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Info" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
||
<p>Information regarding a virtual machine snapshot.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Snapshot name. For a snapshot triggered by a periodic schedule,
|
||
name will be system generated.</p></li>
|
||
<li><p><strong>snapshot_type</strong> (<a class="reference internal" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Type" title="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.Type</span></code></a>) – Snapshot type.</p></li>
|
||
<li><p><strong>created_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Creation time.</p></li>
|
||
<li><p><strong>expires_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Expiry time.
|
||
None if there is no expiry for the snapshot.</p></li>
|
||
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Identifier of the virtual machine for which the snapshot was taken.</p>
|
||
<p>TODO: Remove this once the VM snapshot List/Get is implemented, We
|
||
do not need this since the query is already being performed on a
|
||
specific VM.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>pg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the protection group for which this snapshot was
|
||
taken.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group</span></code>. When methods return a
|
||
value of this class as a return value, the attribute will be an
|
||
identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.protection_group</span></code>.
|
||
None if the snapshot was not taken as part of a protection group.</p></li>
|
||
<li><p><strong>disk_snapshots</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.snapservice.clusters.virtual_machines.html#com.vmware.snapservice.clusters.virtual_machines.disks_client.Snapshots.Info" title="com.vmware.snapservice.clusters.virtual_machines.disks_client.Snapshots.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.snapservice.clusters.virtual_machines.disks_client.Snapshots.Info</span></code></a>) – List of virtual machine disk snapshots that were taken for this
|
||
snapshot instance.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.ListItem">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ListItem</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">snapshot</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.ListItem" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots.ListItem</span></code> class contains information about a protection
|
||
group returned by <a class="reference internal" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.list" title="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Snapshots.list()</span></code></a> method</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>snapshot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine snapshot.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.vm.snapshot</span></code>. When methods return a value
|
||
of this class as a return value, the attribute will be an
|
||
identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.vm.snapshot</span></code>.</p></li>
|
||
<li><p><strong>info</strong> (<a class="reference internal" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Info" title="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.Info</span></code></a>) – Information about the virtual machine snapshot.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.ListResult">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ListResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">items</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.ListResult" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots.ListResult</span></code> class represents the result of
|
||
<a class="reference internal" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.list" title="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Snapshots.list()</span></code></a> method.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>items</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.ListItem" title="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.ListItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.ListItem</span></code></a>) – List of items</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Type">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Type" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Snapshots.Type</span></code> enumeration contains valid snapshot types.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Type.ONE_TIME">
|
||
<span class="sig-name descname"><span class="pre">ONE_TIME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='ONE_TIME')</span></em><a class="headerlink" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Type.ONE_TIME" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Indicates that the snapshot was taken as a one time operation triggered by
|
||
the user.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Type.SCHEDULED">
|
||
<span class="sig-name descname"><span class="pre">SCHEDULED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='SCHEDULED')</span></em><a class="headerlink" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Type.SCHEDULED" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Indicates that a snapshot was taken as part of a periodic schedule.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Type.SYSTEM_CREATED">
|
||
<span class="sig-name descname"><span class="pre">SYSTEM_CREATED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='SYSTEM_CREATED')</span></em><a class="headerlink" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Type.SYSTEM_CREATED" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Indicates that the snapshot was taken by the system</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.get">
|
||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">snapshot</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.get" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Get the detailed information regarding the specified virtual machine
|
||
snapshot.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
||
<li><p><strong>snapshot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine snapshot.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.snapservice.vm.snapshot</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Info" title="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Information about the virtual mahcine snapshot.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no virtual machine
|
||
associated with <code class="docutils literal notranslate"><span class="pre">vm</span></code> or no snapshot associated with <code class="docutils literal notranslate"><span class="pre">snapshot</span></code>
|
||
is found in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
If the service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
If the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the caller is not authorized to perform the operation.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.list">
|
||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.list" title="Permalink to this definition"></a></dt>
|
||
<dd><p>List the snapshots for the given virtual machine.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
||
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.FilterSpec" title="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of matching snapshots for which information should be
|
||
returned.
|
||
If None, the behavior is equivalent to a
|
||
<a class="reference internal" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.FilterSpec" title="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.FilterSpec</span></code></a> with all attributes None which means
|
||
all virtual machine snapshots match the filter.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.ListResult" title="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.ListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.ListResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Information about the snapshots matching the
|
||
<a class="reference internal" href="#com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.FilterSpec" title="com.vmware.snapservice.clusters.virtual_machines_client.Snapshots.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Snapshots.FilterSpec</span></code></a> for the specified virtual machine.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no or no
|
||
virtual machine associated with <a href="#id3"><span class="problematic" id="id4">``</span></a>vm``in the system.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
If validation of the <code class="docutils literal notranslate"><span class="pre">filter</span></code> fails.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
If the service is not available.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
If the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
If the caller is not authorized to perform the operation.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.snapservice.clusters.virtual_machines_client.StubFactory">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.snapservice.clusters.virtual_machines_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.snapservice.clusters.virtual_machines_client.StubFactory" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="com.vmware.snapservice.html" class="btn btn-neutral float-left" title="com.vmware.snapservice package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="com.vmware.snapservice.clusters.virtual_machines.html" class="btn btn-neutral float-right" title="com.vmware.snapservice.clusters.virtual_machines package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2024, Broadcom, Inc..</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |