Merge pull request #183 from anusha94/gh-pages

updating draas docs with latest Task and Replication APIs

vmc-draas/_sources/index.rst.txt

@@ -1,5 +1,5 @@
 .. vAPI documentation master file, created by
-   sphinx-quickstart on Tue Sep  3 15:28:22 2019.
+   sphinx-quickstart on Fri Sep  6 13:52:42 2019.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 

vmc-draas/com.vmware.vmc.draas.html

@@ -217,7 +217,11 @@ names.</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>srm_extension_key_suffix</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>) – Optional custom extension key suffix for SRM. If not specified,
-default extension key will be used.</td>
+default extension key will be used. The custom extension suffix
+must contain 13 characters or less, be composed of letters,
+numbers, ., -, and _ characters. The extension suffix must begin
+and end with a letter or number. The suffix is appended to
+com.vmware.vcDr- to form the full extension key.</td>
 </tr>
 </tbody>
 </table>
@@ -274,6 +278,60 @@ default extension key will be used.</li>
 </table>
 </dd></dl>
 
+<dl class="class">
+<dt id="com.vmware.vmc.draas.model_client.ReplicaDisk">
+<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">ReplicaDisk</code><span class="sig-paren">(</span><em>space_requirement=None</em>, <em>name=None</em>, <em>collection_id=None</em>, <em>datastores_for_single_host_move=None</em>, <em>movable=None</em>, <em>disk_id=None</em>, <em>datastore_mo_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ReplicaDisk" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
+<div class="admonition tip">
+<p class="first admonition-title">Tip</p>
+<p class="last">The arguments are used to initialize data attributes with the same
+names.</p>
+</div>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>space_requirement</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
+<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
+<li><strong>collection_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
+<li><strong>datastores_for_single_host_move</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
+<li><strong>movable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
+<li><strong>disk_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
+<li><strong>datastore_mo_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="class">
+<dt id="com.vmware.vmc.draas.model_client.ReplicaDiskCollection">
+<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">ReplicaDiskCollection</code><span class="sig-paren">(</span><em>collection_id=None</em>, <em>generated=None</em>, <em>disks=None</em>, <em>placeholder_vm_mo_id=None</em>, <em>name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ReplicaDiskCollection" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
+<div class="admonition tip">
+<p class="first admonition-title">Tip</p>
+<p class="last">The arguments are used to initialize data attributes with the same
+names.</p>
+</div>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>collection_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
+<li><strong>generated</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>) – </li>
+<li><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.draas.model_client.ReplicaDisk" title="com.vmware.vmc.draas.model_client.ReplicaDisk"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicaDisk</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
+<li><strong>placeholder_vm_mo_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
+<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 <dl class="class">
 <dt id="com.vmware.vmc.draas.model_client.SiteRecovery">
 <em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">SiteRecovery</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>created=None</em>, <em>updated_by_user_id=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em>, <em>site_recovery_state=None</em>, <em>vr_node=None</em>, <em>srm_nodes=None</em>, <em>sddc_id=None</em>, <em>draas_h5_url=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery" title="Permalink to this definition">¶</a></dt>
@@ -506,7 +564,7 @@ names.</p>
 
 <dl class="class">
 <dt id="com.vmware.vmc.draas.model_client.SiteRecoveryVersions">
-<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">SiteRecoveryVersions</code><span class="sig-paren">(</span><em>sddc_id=None</em>, <em>node_versions=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryVersions" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">SiteRecoveryVersions</code><span class="sig-paren">(</span><em>generated=None</em>, <em>sddc_id=None</em>, <em>node_versions=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryVersions" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
 <div class="admonition tip">
 <p class="first admonition-title">Tip</p>
@@ -518,6 +576,7 @@ names.</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>generated</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>) – </li>
 <li><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
 <li><strong>node_versions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion"><code class="xref py py-class docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – list of site recovery node version</li>
 </ul>

vmc-draas/com.vmware.vmc.html

@@ -184,6 +184,57 @@
 </div>
 <div class="section" id="module-com.vmware.vmc.draas_client">
 <span id="com-vmware-vmc-draas-client-module"></span><h2>com.vmware.vmc.draas_client module<a class="headerlink" href="#module-com.vmware.vmc.draas_client" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="com.vmware.vmc.draas_client.ReplicaDiskCollections">
+<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas_client.</code><code class="descname">ReplicaDiskCollections</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.ReplicaDiskCollections" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<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.</td>
+</tr>
+</tbody>
+</table>
+<dl class="method">
+<dt id="com.vmware.vmc.draas_client.ReplicaDiskCollections.get">
+<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>datastore_mo_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.ReplicaDiskCollections.get" title="Permalink to this definition">¶</a></dt>
+<dd><p>Query replica disk collections</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</li>
+<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – sddc identifier (required)</li>
+<li><strong>datastore_mo_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Represents the datastore moref id to search. (optional)</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.ReplicaDiskCollection" title="com.vmware.vmc.draas.model_client.ReplicaDiskCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.ReplicaDiskCollection</span></code></a></p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code> 
+Unauthorized</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code> 
+Forbidden</p>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code> 
+Not found</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
 <dl class="class">
 <dt id="com.vmware.vmc.draas_client.SiteRecovery">
 <em class="property">class </em><code class="descclassname">com.vmware.vmc.draas_client.</code><code class="descname">SiteRecovery</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecovery" title="Permalink to this definition">¶</a></dt>
@@ -539,6 +590,56 @@ Cannot find site recovery versions for sddc identifier</p>
 </table>
 </dd></dl>
 
+<dl class="class">
+<dt id="com.vmware.vmc.draas_client.Task">
+<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas_client.</code><code class="descname">Task</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.Task" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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.</td>
+</tr>
+</tbody>
+</table>
+<dl class="method">
+<dt id="com.vmware.vmc.draas_client.Task.get">
+<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>task</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.Task.get" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieve details of a task.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</li>
+<li><strong>task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – task identifier (required)</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.draas.model.Task</p>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code> 
+Unauthorized</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code> 
+Forbidden</p>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code> 
+Cannot find the task with given identifier</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
 </div>
 </div>
 

vmc-draas/genindex.html

@@ -160,6 +160,7 @@
  | <a href="#G"><strong>G</strong></a>
  | <a href="#N"><strong>N</strong></a>
  | <a href="#P"><strong>P</strong></a>
+ | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
  | <a href="#T"><strong>T</strong></a>
  | <a href="#V"><strong>V</strong></a>
@@ -224,16 +225,20 @@
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.SiteRecovery.get">get() (com.vmware.vmc.draas_client.SiteRecovery method)</a>
+      <li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.ReplicaDiskCollections.get">get() (com.vmware.vmc.draas_client.ReplicaDiskCollections method)</a>
 
       <ul>
+        <li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.SiteRecovery.get">(com.vmware.vmc.draas_client.SiteRecovery method)</a>
+</li>
         <li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.SiteRecoveryVersions.get">(com.vmware.vmc.draas_client.SiteRecoveryVersions method)</a>
 </li>
-      </ul></li>
+        <li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.Task.get">(com.vmware.vmc.draas_client.Task method)</a>
-      <li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_max_retries">get_max_retries() (vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter method)</a>
 </li>
+      </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_max_retries">get_max_retries() (vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter method)</a>
+</li>
       <li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_security_context">get_security_context() (vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter method)</a>
 </li>
       <li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.SiteRecoveryVersions.GET_VERSION_SOURCE_LS">GET_VERSION_SOURCE_LS (com.vmware.vmc.draas_client.SiteRecoveryVersions attribute)</a>
@@ -275,6 +280,20 @@
   </ul></td>
 </tr></table>
 
+<h2 id="R">R</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.ReplicaDisk">ReplicaDisk (class in com.vmware.vmc.draas.model_client)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.ReplicaDiskCollection">ReplicaDiskCollection (class in com.vmware.vmc.draas.model_client)</a>
+</li>
+      <li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.ReplicaDiskCollections">ReplicaDiskCollections (class in com.vmware.vmc.draas_client)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="S">S</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -349,7 +368,11 @@
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task">Task (class in com.vmware.vmc.draas.model_client)</a>
+
+      <ul>
+        <li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.Task">(class in com.vmware.vmc.draas_client)</a>
 </li>
+      </ul></li>
       <li><a href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.TaskProgressPhase">TaskProgressPhase (class in com.vmware.vmc.draas.model_client)</a>
 </li>
   </ul></td>