Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-26 19:29:58 -05:00
Code
8ccc089bd0
vsphere-automation-sdk-python/openapi/docs/build/html/vmc/draas/vmware.vmc.draas.api.html

799 lines
42 KiB
HTML
Raw Normal View History

adding openapi docs
2020-07-14 23:31:34 -04:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>vmware.vmc.draas.api package &mdash; VMware Automation SDK for Python 0.1.0 documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
modifying docs for console apis and draas
2020-07-15 04:28:09 -04:00
<link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
adding openapi docs
2020-07-14 23:31:34 -04:00
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="vmware.vmc.draas.models package" href="vmware.vmc.draas.models.html" />
<link rel="prev" title="vmware.vmc.draas package" href="vmware.vmc.draas.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home" alt="Documentation Home"> VMware Automation SDK for Python
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../console/modules.html">console</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">draas</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="vmware.html">vmware package</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="vmware.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="vmware.vmc.html">vmware.vmc package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="vmware.html#module-vmware">Module contents</a></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="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">VMware Automation SDK for Python</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="modules.html">draas</a> &raquo;</li>
<li><a href="vmware.html">vmware package</a> &raquo;</li>
<li><a href="vmware.vmc.html">vmware.vmc package</a> &raquo;</li>
<li><a href="vmware.vmc.draas.html">vmware.vmc.draas package</a> &raquo;</li>
<li>vmware.vmc.draas.api package</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/vmc/draas/vmware.vmc.draas.api.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="vmware-vmc-draas-api-package">
<h1>vmware.vmc.draas.api package<a class="headerlink" href="#vmware-vmc-draas-api-package" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
modifying docs for console apis and draas
2020-07-15 04:28:09 -04:00
<div class="section" id="module-vmware.vmc.draas.api.site_recovery_api">
<span id="vmware-vmc-draas-api-site-recovery-api-module"></span><h2>vmware.vmc.draas.api.site_recovery_api module<a class="headerlink" href="#module-vmware.vmc.draas.api.site_recovery_api" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Copyright (c) 2020 VMware, Inc</p></li>
<li><p>SPDX-License-Identifier: MIT</p></li>
</ul>
<p><strong>VMC DRaaS APIs</strong></p>
<p>The version of the OpenAPI document: 1.0
Contact: <a class="reference external" href="mailto:anushah&#37;&#52;&#48;vmware&#46;com">anushah<span>&#64;</span>vmware<span>&#46;</span>com</a>
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
<dl class="py class">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi">
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.draas.api.site_recovery_api.</code><code class="sig-name descname">SiteRecoveryApi</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">api_client</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>NOTE: This class is auto generated by OpenAPI Generator
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
<p>Do not edit the class manually.</p>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.activate_site_recovery">
<code class="sig-name descname">activate_site_recovery</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.activate_site_recovery" title="Permalink to this definition"></a></dt>
<dd><p>Activate site recovery for the specified sddc # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.activate_site_recovery(org, sddc, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>activate_site_recovery_config</strong> (<a class="reference internal" href="vmware.vmc.draas.models.html#vmware.vmc.draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig" title="vmware.vmc.draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig"><em>ActivateSiteRecoveryConfig</em></a>) – Customization, for example can specify custom extension key suffix for SRM.</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.activate_site_recovery_with_http_info">
<code class="sig-name descname">activate_site_recovery_with_http_info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.activate_site_recovery_with_http_info" title="Permalink to this definition"></a></dt>
<dd><p>Activate site recovery for the specified sddc # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.activate_site_recovery_with_http_info(org, sddc, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>activate_site_recovery_config</strong> (<a class="reference internal" href="vmware.vmc.draas.models.html#vmware.vmc.draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig" title="vmware.vmc.draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig"><em>ActivateSiteRecoveryConfig</em></a>) – Customization, for example can specify custom extension key suffix for SRM.</p></li>
<li><p><strong>_return_http_data_only</strong> – response data without head status code
and headers</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>tuple(Task, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.deactivate_site_recovery">
<code class="sig-name descname">deactivate_site_recovery</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.deactivate_site_recovery" title="Permalink to this definition"></a></dt>
<dd><p>Deactivate site recovery for the specified sddc # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.deactivate_site_recovery(org, sddc, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>force</strong> (<em>bool</em>) – If = ‘true’, will deactivate site recovery forcefully.</p></li>
<li><p><strong>deactivate_hcx</strong> (<em>bool</em>) – If = ‘true’, will deactivate HCX.</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.deactivate_site_recovery_with_http_info">
<code class="sig-name descname">deactivate_site_recovery_with_http_info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.deactivate_site_recovery_with_http_info" title="Permalink to this definition"></a></dt>
<dd><p>Deactivate site recovery for the specified sddc # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.deactivate_site_recovery_with_http_info(org, sddc, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>force</strong> (<em>bool</em>) – If = ‘true’, will deactivate site recovery forcefully.</p></li>
<li><p><strong>deactivate_hcx</strong> (<em>bool</em>) – If = ‘true’, will deactivate HCX.</p></li>
<li><p><strong>_return_http_data_only</strong> – response data without head status code
and headers</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>tuple(Task, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.delete_srm">
<code class="sig-name descname">delete_srm</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">srm_node</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.delete_srm" title="Permalink to this definition"></a></dt>
<dd><p>Delete a SRM server. # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.delete_srm(org, sddc, srm_node, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>srm_node</strong> (<em>str</em>) – SRM node identifier (required)</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.delete_srm_with_http_info">
<code class="sig-name descname">delete_srm_with_http_info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">srm_node</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.delete_srm_with_http_info" title="Permalink to this definition"></a></dt>
<dd><p>Delete a SRM server. # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.delete_srm_with_http_info(org, sddc, srm_node, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>srm_node</strong> (<em>str</em>) – SRM node identifier (required)</p></li>
<li><p><strong>_return_http_data_only</strong> – response data without head status code
and headers</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>tuple(Task, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.get_replica_disk_collections">
<code class="sig-name descname">get_replica_disk_collections</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.get_replica_disk_collections" title="Permalink to this definition"></a></dt>
<dd><p>Query replica disk collections # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.get_replica_disk_collections(org, sddc, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>datastore_mo_id</strong> (<em>str</em>) – Represents the datastore moref id to search.</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>list[ReplicaDiskCollection]
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.get_replica_disk_collections_with_http_info">
<code class="sig-name descname">get_replica_disk_collections_with_http_info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.get_replica_disk_collections_with_http_info" title="Permalink to this definition"></a></dt>
<dd><p>Query replica disk collections # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.get_replica_disk_collections_with_http_info(org, sddc, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>datastore_mo_id</strong> (<em>str</em>) – Represents the datastore moref id to search.</p></li>
<li><p><strong>_return_http_data_only</strong> – response data without head status code
and headers</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>tuple(list[ReplicaDiskCollection], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.get_site_recovery">
<code class="sig-name descname">get_site_recovery</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.get_site_recovery" title="Permalink to this definition"></a></dt>
<dd><p>Query site recovery configuration for the specified sddc # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.get_site_recovery(org, sddc, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>SiteRecovery
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.get_site_recovery_versions">
<code class="sig-name descname">get_site_recovery_versions</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.get_site_recovery_versions" title="Permalink to this definition"></a></dt>
<dd><p>Query site recovery versions for the specified sddc # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.get_site_recovery_versions(org, sddc, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>version_source</strong> (<em>str</em>) – Represents the source for getting the version from.</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>SiteRecoveryVersions
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.get_site_recovery_versions_with_http_info">
<code class="sig-name descname">get_site_recovery_versions_with_http_info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.get_site_recovery_versions_with_http_info" title="Permalink to this definition"></a></dt>
<dd><p>Query site recovery versions for the specified sddc # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.get_site_recovery_versions_with_http_info(org, sddc, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>version_source</strong> (<em>str</em>) – Represents the source for getting the version from.</p></li>
<li><p><strong>_return_http_data_only</strong> – response data without head status code
and headers</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>tuple(SiteRecoveryVersions, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.get_site_recovery_with_http_info">
<code class="sig-name descname">get_site_recovery_with_http_info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.get_site_recovery_with_http_info" title="Permalink to this definition"></a></dt>
<dd><p>Query site recovery configuration for the specified sddc # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.get_site_recovery_with_http_info(org, sddc, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>_return_http_data_only</strong> – response data without head status code
and headers</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>tuple(SiteRecovery, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.provision_additional_srm">
<code class="sig-name descname">provision_additional_srm</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.provision_additional_srm" title="Permalink to this definition"></a></dt>
<dd><p>Provision an additional SRM server. # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.provision_additional_srm(org, sddc, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>provision_srm_config</strong> (<a class="reference internal" href="vmware.vmc.draas.models.html#vmware.vmc.draas.models.provision_srm_config.ProvisionSrmConfig" title="vmware.vmc.draas.models.provision_srm_config.ProvisionSrmConfig"><em>ProvisionSrmConfig</em></a>) – Customization, for example can specify custom extension key suffix for SRM.</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.provision_additional_srm_with_http_info">
<code class="sig-name descname">provision_additional_srm_with_http_info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.site_recovery_api.SiteRecoveryApi.provision_additional_srm_with_http_info" title="Permalink to this definition"></a></dt>
<dd><p>Provision an additional SRM server. # noqa: E501</p>
<p>This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.provision_additional_srm_with_http_info(org, sddc, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<em>str</em>) – sddc identifier (required)</p></li>
<li><p><strong>provision_srm_config</strong> (<a class="reference internal" href="vmware.vmc.draas.models.html#vmware.vmc.draas.models.provision_srm_config.ProvisionSrmConfig" title="vmware.vmc.draas.models.provision_srm_config.ProvisionSrmConfig"><em>ProvisionSrmConfig</em></a>) – Customization, for example can specify custom extension key suffix for SRM.</p></li>
<li><p><strong>_return_http_data_only</strong> – response data without head status code
and headers</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>tuple(Task, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
adding openapi docs
2020-07-14 23:31:34 -04:00
</div>
modifying docs for console apis and draas
2020-07-15 04:28:09 -04:00
<div class="section" id="module-vmware.vmc.draas.api.task_api">
<span id="vmware-vmc-draas-api-task-api-module"></span><h2>vmware.vmc.draas.api.task_api module<a class="headerlink" href="#module-vmware.vmc.draas.api.task_api" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Copyright (c) 2020 VMware, Inc</p></li>
<li><p>SPDX-License-Identifier: MIT</p></li>
</ul>
<p><strong>VMC DRaaS APIs</strong></p>
<p>The version of the OpenAPI document: 1.0
Contact: <a class="reference external" href="mailto:anushah&#37;&#52;&#48;vmware&#46;com">anushah<span>&#64;</span>vmware<span>&#46;</span>com</a>
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
<dl class="py class">
<dt id="vmware.vmc.draas.api.task_api.TaskApi">
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.draas.api.task_api.</code><code class="sig-name descname">TaskApi</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">api_client</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.task_api.TaskApi" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>NOTE: This class is auto generated by OpenAPI Generator
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
<p>Do not edit the class manually.</p>
<dl class="py method">
<dt id="vmware.vmc.draas.api.task_api.TaskApi.vmc_draas_api_orgs_org_tasks_task_get">
<code class="sig-name descname">vmc_draas_api_orgs_org_tasks_task_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">task</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.task_api.TaskApi.vmc_draas_api_orgs_org_tasks_task_get" title="Permalink to this definition"></a></dt>
<dd><p>Get task details # noqa: E501</p>
<p>Retrieve details of a task. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.vmc_draas_api_orgs_org_tasks_task_get(org, task, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>task</strong> (<em>str</em>) – task identifier (required)</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.draas.api.task_api.TaskApi.vmc_draas_api_orgs_org_tasks_task_get_with_http_info">
<code class="sig-name descname">vmc_draas_api_orgs_org_tasks_task_get_with_http_info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">task</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.draas.api.task_api.TaskApi.vmc_draas_api_orgs_org_tasks_task_get_with_http_info" title="Permalink to this definition"></a></dt>
<dd><p>Get task details # noqa: E501</p>
<p>Retrieve details of a task. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
&gt;&gt;&gt; thread = api.vmc_draas_api_orgs_org_tasks_task_get_with_http_info(org, task, async_req=True)
&gt;&gt;&gt; result = thread.get()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bool</strong> (<em>async_req</em>) – execute request asynchronously</p></li>
<li><p><strong>org</strong> (<em>str</em>) – Organization identifier (required)</p></li>
<li><p><strong>task</strong> (<em>str</em>) – task identifier (required)</p></li>
<li><p><strong>_return_http_data_only</strong> – response data without head status code
and headers</p></li>
<li><p><strong>_preload_content</strong> – if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.</p></li>
<li><p><strong>_request_timeout</strong> – timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>tuple(Task, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
adding openapi docs
2020-07-14 23:31:34 -04:00
</div>
modifying docs for console apis and draas
2020-07-15 04:28:09 -04:00
<div class="section" id="module-vmware.vmc.draas.api">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-vmware.vmc.draas.api" title="Permalink to this headline"></a></h2>
adding openapi docs
2020-07-14 23:31:34 -04:00
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="vmware.vmc.draas.models.html" class="btn btn-neutral float-right" title="vmware.vmc.draas.models package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="vmware.vmc.draas.html" class="btn btn-neutral float-left" title="vmware.vmc.draas package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, VMware Inc.
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Copy Permalink