mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-26 19:29:58 -05:00
5506 lines
368 KiB
HTML
5506 lines
368 KiB
HTML
|
||
|
||
<!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.console.api package — 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" />
|
||
<link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="../../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||
<script src="../../_static/jquery.js"></script>
|
||
<script src="../../_static/underscore.js"></script>
|
||
<script src="../../_static/doctools.js"></script>
|
||
<script src="../../_static/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="../../_static/js/theme.js"></script>
|
||
|
||
|
||
<link rel="index" title="Index" href="../../genindex.html" />
|
||
<link rel="search" title="Search" href="../../search.html" />
|
||
<link rel="next" title="vmware.vmc.console.models package" href="vmware.vmc.console.models.html" />
|
||
<link rel="prev" title="vmware.vmc.console package" href="vmware.vmc.console.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 current"><a class="reference internal" href="modules.html">console</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> »</li>
|
||
|
||
<li><a href="modules.html">console</a> »</li>
|
||
|
||
<li><a href="vmware.html">vmware package</a> »</li>
|
||
|
||
<li><a href="vmware.vmc.html">vmware.vmc package</a> »</li>
|
||
|
||
<li><a href="vmware.vmc.console.html">vmware.vmc.console package</a> »</li>
|
||
|
||
<li>vmware.vmc.console.api package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="../../_sources/vmc/console/vmware.vmc.console.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-console-api-package">
|
||
<h1>vmware.vmc.console.api package<a class="headerlink" href="#vmware-vmc-console-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>
|
||
<div class="section" id="module-vmware.vmc.console.api.account_linking_api">
|
||
<span id="vmware-vmc-console-api-account-linking-api-module"></span><h2>vmware.vmc.console.api.account_linking_api module<a class="headerlink" href="#module-vmware.vmc.console.api.account_linking_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.account_linking_api.AccountLinkingApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.account_linking_api.</code><code class="sig-name descname">AccountLinkingApi</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.console.api.account_linking_api.AccountLinkingApi" 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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_async_get">
|
||
<code class="sig-name descname">orgs_org_account_link_compatible_subnets_async_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">linked_account_id</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_async_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets a customer’s compatible subnets for account linking via a task. The information is returned as a member of the task (found in task.params[‘subnet_list_result’] when you are notified it is complete), and it’s documented under ref /definitions/AwsCompatibleSubnets # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_compatible_subnets_async_get(org, linked_account_id, async_req=True)
|
||
>>> 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>linked_account_id</strong> (<em>str</em>) – The linked connected account identifier (required)</p></li>
|
||
<li><p><strong>region</strong> (<em>str</em>) – The region of the cloud resources to work in</p></li>
|
||
<li><p><strong>sddc</strong> (<em>str</em>) – sddc</p></li>
|
||
<li><p><strong>instance_type</strong> (<em>str</em>) – The server instance type to be used.</p></li>
|
||
<li><p><strong>sddc_type</strong> (<em>str</em>) – The sddc type to be used. (1NODE, SingleAZ, MultiAZ)</p></li>
|
||
<li><p><strong>num_of_hosts</strong> (<em>int</em>) – The number of hosts</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_async_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_account_link_compatible_subnets_async_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">linked_account_id</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_async_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets a customer’s compatible subnets for account linking via a task. The information is returned as a member of the task (found in task.params[‘subnet_list_result’] when you are notified it is complete), and it’s documented under ref /definitions/AwsCompatibleSubnets # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_compatible_subnets_async_get_with_http_info(org, linked_account_id, async_req=True)
|
||
>>> 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>linked_account_id</strong> (<em>str</em>) – The linked connected account identifier (required)</p></li>
|
||
<li><p><strong>region</strong> (<em>str</em>) – The region of the cloud resources to work in</p></li>
|
||
<li><p><strong>sddc</strong> (<em>str</em>) – sddc</p></li>
|
||
<li><p><strong>instance_type</strong> (<em>str</em>) – The server instance type to be used.</p></li>
|
||
<li><p><strong>sddc_type</strong> (<em>str</em>) – The sddc type to be used. (1NODE, SingleAZ, MultiAZ)</p></li>
|
||
<li><p><strong>num_of_hosts</strong> (<em>int</em>) – The number of hosts</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_async_post">
|
||
<code class="sig-name descname">orgs_org_account_link_compatible_subnets_async_post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">aws_subnet</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_async_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets which subnet to use to link accounts and finishes the linking process via a task # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_compatible_subnets_async_post(org, aws_subnet, async_req=True)
|
||
>>> 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>aws_subnet</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.aws_subnet.AwsSubnet" title="vmware.vmc.console.models.aws_subnet.AwsSubnet"><em>AwsSubnet</em></a>) – The subnet chosen by the customer (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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_async_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_account_link_compatible_subnets_async_post_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">aws_subnet</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_async_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets which subnet to use to link accounts and finishes the linking process via a task # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_compatible_subnets_async_post_with_http_info(org, aws_subnet, async_req=True)
|
||
>>> 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>aws_subnet</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.aws_subnet.AwsSubnet" title="vmware.vmc.console.models.aws_subnet.AwsSubnet"><em>AwsSubnet</em></a>) – The subnet chosen by the customer (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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_get">
|
||
<code class="sig-name descname">orgs_org_account_link_compatible_subnets_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">linked_account_id</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets a customer’s compatible subnets for account linking # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_compatible_subnets_get(org, linked_account_id, async_req=True)
|
||
>>> 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>linked_account_id</strong> (<em>str</em>) – The linked connected account identifier (required)</p></li>
|
||
<li><p><strong>region</strong> (<em>str</em>) – The region of the cloud resources to work in</p></li>
|
||
<li><p><strong>sddc</strong> (<em>str</em>) – sddc</p></li>
|
||
<li><p><strong>force_refresh</strong> (<em>bool</em>) – When true, forces the mappings for datacenters to be refreshed for the connected account.</p></li>
|
||
<li><p><strong>instance_type</strong> (<em>str</em>) – The server instance type to be used.</p></li>
|
||
<li><p><strong>sddc_type</strong> (<em>str</em>) – The sddc type to be used. (1NODE, SingleAZ, MultiAZ)</p></li>
|
||
<li><p><strong>num_of_hosts</strong> (<em>int</em>) – The number of hosts</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>AwsCompatibleSubnets
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_account_link_compatible_subnets_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">linked_account_id</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets a customer’s compatible subnets for account linking # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_compatible_subnets_get_with_http_info(org, linked_account_id, async_req=True)
|
||
>>> 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>linked_account_id</strong> (<em>str</em>) – The linked connected account identifier (required)</p></li>
|
||
<li><p><strong>region</strong> (<em>str</em>) – The region of the cloud resources to work in</p></li>
|
||
<li><p><strong>sddc</strong> (<em>str</em>) – sddc</p></li>
|
||
<li><p><strong>force_refresh</strong> (<em>bool</em>) – When true, forces the mappings for datacenters to be refreshed for the connected account.</p></li>
|
||
<li><p><strong>instance_type</strong> (<em>str</em>) – The server instance type to be used.</p></li>
|
||
<li><p><strong>sddc_type</strong> (<em>str</em>) – The sddc type to be used. (1NODE, SingleAZ, MultiAZ)</p></li>
|
||
<li><p><strong>num_of_hosts</strong> (<em>int</em>) – The number of hosts</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(AwsCompatibleSubnets, 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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_post">
|
||
<code class="sig-name descname">orgs_org_account_link_compatible_subnets_post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets which subnet to use to link accounts and finishes the linking process # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_compatible_subnets_post(org, async_req=True)
|
||
>>> 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>_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>AwsSubnet
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_account_link_compatible_subnets_post_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_compatible_subnets_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets which subnet to use to link accounts and finishes the linking process # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_compatible_subnets_post_with_http_info(org, async_req=True)
|
||
>>> 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>_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(AwsSubnet, 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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_connected_accounts_get">
|
||
<code class="sig-name descname">orgs_org_account_link_connected_accounts_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_connected_accounts_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get a list of connected accounts # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_connected_accounts_get(org, async_req=True)
|
||
>>> 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>provider</strong> (<em>str</em>) – The cloud provider of the SDDC (AWS or ZeroCloud). Default value is AWS.</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[AwsCustomerConnectedAccount]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_connected_accounts_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_account_link_connected_accounts_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_connected_accounts_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get a list of connected accounts # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_connected_accounts_get_with_http_info(org, async_req=True)
|
||
>>> 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>provider</strong> (<em>str</em>) – The cloud provider of the SDDC (AWS or ZeroCloud). Default value is AWS.</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[AwsCustomerConnectedAccount], 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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_connected_accounts_linked_account_path_id_delete">
|
||
<code class="sig-name descname">orgs_org_account_link_connected_accounts_linked_account_path_id_delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">linked_account_path_id</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_connected_accounts_linked_account_path_id_delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete a particular connected (linked) account. # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_connected_accounts_linked_account_path_id_delete(org, linked_account_path_id, async_req=True)
|
||
>>> 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>linked_account_path_id</strong> (<em>str</em>) – The linked connected account identifier (required)</p></li>
|
||
<li><p><strong>force_even_when_sddc_present</strong> (<em>bool</em>) – When true, forcibly removes a connected account even when SDDC’s are still linked to it.</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>AwsCustomerConnectedAccount
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_connected_accounts_linked_account_path_id_delete_with_http_info">
|
||
<code class="sig-name descname">orgs_org_account_link_connected_accounts_linked_account_path_id_delete_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">linked_account_path_id</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_connected_accounts_linked_account_path_id_delete_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete a particular connected (linked) account. # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_connected_accounts_linked_account_path_id_delete_with_http_info(org, linked_account_path_id, async_req=True)
|
||
>>> 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>linked_account_path_id</strong> (<em>str</em>) – The linked connected account identifier (required)</p></li>
|
||
<li><p><strong>force_even_when_sddc_present</strong> (<em>bool</em>) – When true, forcibly removes a connected account even when SDDC’s are still linked to it.</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(AwsCustomerConnectedAccount, 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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_get">
|
||
<code class="sig-name descname">orgs_org_account_link_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets a link that can be used on a customer’s account to start the linking process. # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_get(org, async_req=True)
|
||
>>> 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>_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>None
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_account_link_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets a link that can be used on a customer’s account to start the linking process. # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_get_with_http_info(org, async_req=True)
|
||
>>> 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>_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>None
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_map_customer_zones_post">
|
||
<code class="sig-name descname">orgs_org_account_link_map_customer_zones_post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">map_zones_request</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_map_customer_zones_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Creates a task to re-map customer’s datacenters across zones. # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_map_customer_zones_post(org, map_zones_request, async_req=True)
|
||
>>> 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>map_zones_request</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.map_zones_request.MapZonesRequest" title="vmware.vmc.console.models.map_zones_request.MapZonesRequest"><em>MapZonesRequest</em></a>) – The zones request information about who to map and what to map. (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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_map_customer_zones_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_account_link_map_customer_zones_post_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">map_zones_request</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_map_customer_zones_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Creates a task to re-map customer’s datacenters across zones. # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_map_customer_zones_post_with_http_info(org, map_zones_request, async_req=True)
|
||
>>> 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>map_zones_request</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.map_zones_request.MapZonesRequest" title="vmware.vmc.console.models.map_zones_request.MapZonesRequest"><em>MapZonesRequest</em></a>) – The zones request information about who to map and what to map. (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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_sddc_connections_get">
|
||
<code class="sig-name descname">orgs_org_account_link_sddc_connections_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_sddc_connections_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get a list of SDDC connections currently setup for the customer’s organization. # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_sddc_connections_get(org, async_req=True)
|
||
>>> 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</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[AwsSddcConnection]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_sddc_connections_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_account_link_sddc_connections_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.account_linking_api.AccountLinkingApi.orgs_org_account_link_sddc_connections_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get a list of SDDC connections currently setup for the customer’s organization. # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_account_link_sddc_connections_get_with_http_info(org, async_req=True)
|
||
>>> 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</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[AwsSddcConnection], status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.addons_api">
|
||
<span id="vmware-vmc-console-api-addons-api-module"></span><h2>vmware.vmc.console.api.addons_api module<a class="headerlink" href="#module-vmware.vmc.console.api.addons_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.addons_api.AddonsApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.addons_api.</code><code class="sig-name descname">AddonsApi</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.console.api.addons_api.AddonsApi" 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.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</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.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501</p>
|
||
<p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get(org, sddc_id, addon_type, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (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>list[NewCredentials]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_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">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</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.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501</p>
|
||
<p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info(org, sddc_id, addon_type, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (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(list[NewCredentials], 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.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</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.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get credential details by name # noqa: E501</p>
|
||
<p>Get credential details by name # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get(org, sddc_id, addon_type, name, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (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>NewCredentials
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_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">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</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.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get credential details by name # noqa: E501</p>
|
||
<p>Get credential details by name # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info(org, sddc_id, addon_type, name, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (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(NewCredentials, 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.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update credential details # noqa: E501</p>
|
||
<p>Update credential details # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put(org, sddc_id, addon_type, name, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.update_credentials.UpdateCredentials" title="vmware.vmc.console.models.update_credentials.UpdateCredentials"><em>UpdateCredentials</em></a>) – Credentials update payload (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>NewCredentials
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_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_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update credential details # noqa: E501</p>
|
||
<p>Update credential details # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info(org, sddc_id, addon_type, name, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.update_credentials.UpdateCredentials" title="vmware.vmc.console.models.update_credentials.UpdateCredentials"><em>UpdateCredentials</em></a>) – Credentials update payload (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(NewCredentials, 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.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Associate a new add on credentials with the SDDC such as HCX # noqa: E501</p>
|
||
<p>Associated a new add on credentials with the SDDC such as HCX # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post(org, sddc_id, addon_type, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.new_credentials.NewCredentials" title="vmware.vmc.console.models.new_credentials.NewCredentials"><em>NewCredentials</em></a>) – Credentials creation payload (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>NewCredentials
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_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_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.addons_api.AddonsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Associate a new add on credentials with the SDDC such as HCX # noqa: E501</p>
|
||
<p>Associated a new add on credentials with the SDDC such as HCX # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info(org, sddc_id, addon_type, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.new_credentials.NewCredentials" title="vmware.vmc.console.models.new_credentials.NewCredentials"><em>NewCredentials</em></a>) – Credentials creation payload (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(NewCredentials, status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.clusters_api">
|
||
<span id="vmware-vmc-console-api-clusters-api-module"></span><h2>vmware.vmc.console.api.clusters_api module<a class="headerlink" href="#module-vmware.vmc.console.api.clusters_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.clusters_api.ClustersApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.clusters_api.</code><code class="sig-name descname">ClustersApi</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.console.api.clusters_api.ClustersApi" 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.console.api.clusters_api.ClustersApi.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post</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">cluster</span></em>, <em class="sig-param"><span class="n">cluster_reconfigure_params</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.console.api.clusters_api.ClustersApi.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Initiate a reconfiguration for the cluster. # noqa: E501</p>
|
||
<p>This reconfiguration will handle changing both the number of hosts and the cluster storage capacity. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post(org, sddc, cluster, cluster_reconfigure_params, async_req=True)
|
||
>>> 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>cluster</strong> (<em>str</em>) – cluster identifier (required)</p></li>
|
||
<li><p><strong>cluster_reconfigure_params</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.cluster_reconfigure_params.ClusterReconfigureParams" title="vmware.vmc.console.models.cluster_reconfigure_params.ClusterReconfigureParams"><em>ClusterReconfigureParams</em></a>) – clusterReconfigureParams (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.console.api.clusters_api.ClustersApi.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post_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">cluster</span></em>, <em class="sig-param"><span class="n">cluster_reconfigure_params</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.console.api.clusters_api.ClustersApi.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Initiate a reconfiguration for the cluster. # noqa: E501</p>
|
||
<p>This reconfiguration will handle changing both the number of hosts and the cluster storage capacity. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post_with_http_info(org, sddc, cluster, cluster_reconfigure_params, async_req=True)
|
||
>>> 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>cluster</strong> (<em>str</em>) – cluster identifier (required)</p></li>
|
||
<li><p><strong>cluster_reconfigure_params</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.cluster_reconfigure_params.ClusterReconfigureParams" title="vmware.vmc.console.models.cluster_reconfigure_params.ClusterReconfigureParams"><em>ClusterReconfigureParams</em></a>) – clusterReconfigureParams (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>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.config_storage_api">
|
||
<span id="vmware-vmc-console-api-config-storage-api-module"></span><h2>vmware.vmc.console.api.config_storage_api module<a class="headerlink" href="#module-vmware.vmc.console.api.config_storage_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.config_storage_api.ConfigStorageApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.config_storage_api.</code><code class="sig-name descname">ConfigStorageApi</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.console.api.config_storage_api.ConfigStorageApi" 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.console.api.config_storage_api.ConfigStorageApi.orgs_org_sddcs_sddc_clusters_cluster_config_constraints_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_clusters_cluster_config_constraints_get</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">cluster</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.console.api.config_storage_api.ConfigStorageApi.orgs_org_sddcs_sddc_clusters_cluster_config_constraints_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get storage size constraints on existing cluster. # noqa: E501</p>
|
||
<p>This API provides the storage choices available when reconfiguring storage in a cluster. The constraints returned will give vSAN reconfiguration biases and available vSAN capacities per reconfiguration bias. The constraints also indicate the default vSAN capacity per reconfiguration biases as well as the default reconfiguration bias. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_config_constraints_get(org, sddc, cluster, async_req=True)
|
||
>>> 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>cluster</strong> (<em>str</em>) – cluster identifier (required)</p></li>
|
||
<li><p><strong>expected_num_hosts</strong> (<em>int</em>) – The expected number of hosts in the cluster. If not specified, returned is based on current number of hosts in the cluster.</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>VsanClusterReconfigConstraints
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.config_storage_api.ConfigStorageApi.orgs_org_sddcs_sddc_clusters_cluster_config_constraints_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_clusters_cluster_config_constraints_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">sddc</span></em>, <em class="sig-param"><span class="n">cluster</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.console.api.config_storage_api.ConfigStorageApi.orgs_org_sddcs_sddc_clusters_cluster_config_constraints_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get storage size constraints on existing cluster. # noqa: E501</p>
|
||
<p>This API provides the storage choices available when reconfiguring storage in a cluster. The constraints returned will give vSAN reconfiguration biases and available vSAN capacities per reconfiguration bias. The constraints also indicate the default vSAN capacity per reconfiguration biases as well as the default reconfiguration bias. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_config_constraints_get_with_http_info(org, sddc, cluster, async_req=True)
|
||
>>> 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>cluster</strong> (<em>str</em>) – cluster identifier (required)</p></li>
|
||
<li><p><strong>expected_num_hosts</strong> (<em>int</em>) – The expected number of hosts in the cluster. If not specified, returned is based on current number of hosts in the cluster.</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(VsanClusterReconfigConstraints, status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.credentials_api">
|
||
<span id="vmware-vmc-console-api-credentials-api-module"></span><h2>vmware.vmc.console.api.credentials_api module<a class="headerlink" href="#module-vmware.vmc.console.api.credentials_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.credentials_api.CredentialsApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.credentials_api.</code><code class="sig-name descname">CredentialsApi</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.console.api.credentials_api.CredentialsApi" 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.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</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.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501</p>
|
||
<p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get(org, sddc_id, addon_type, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (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>list[NewCredentials]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_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">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</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.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501</p>
|
||
<p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info(org, sddc_id, addon_type, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (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(list[NewCredentials], 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.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</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.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get credential details by name # noqa: E501</p>
|
||
<p>Get credential details by name # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get(org, sddc_id, addon_type, name, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (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>NewCredentials
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_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">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</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.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get credential details by name # noqa: E501</p>
|
||
<p>Get credential details by name # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info(org, sddc_id, addon_type, name, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (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(NewCredentials, 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.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update credential details # noqa: E501</p>
|
||
<p>Update credential details # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put(org, sddc_id, addon_type, name, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.update_credentials.UpdateCredentials" title="vmware.vmc.console.models.update_credentials.UpdateCredentials"><em>UpdateCredentials</em></a>) – Credentials update payload (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>NewCredentials
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_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_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update credential details # noqa: E501</p>
|
||
<p>Update credential details # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info(org, sddc_id, addon_type, name, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.update_credentials.UpdateCredentials" title="vmware.vmc.console.models.update_credentials.UpdateCredentials"><em>UpdateCredentials</em></a>) – Credentials update payload (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(NewCredentials, 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.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Associate a new add on credentials with the SDDC such as HCX # noqa: E501</p>
|
||
<p>Associated a new add on credentials with the SDDC such as HCX # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post(org, sddc_id, addon_type, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.new_credentials.NewCredentials" title="vmware.vmc.console.models.new_credentials.NewCredentials"><em>NewCredentials</em></a>) – Credentials creation payload (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>NewCredentials
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_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_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.credentials_api.CredentialsApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Associate a new add on credentials with the SDDC such as HCX # noqa: E501</p>
|
||
<p>Associated a new add on credentials with the SDDC such as HCX # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info(org, sddc_id, addon_type, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.new_credentials.NewCredentials" title="vmware.vmc.console.models.new_credentials.NewCredentials"><em>NewCredentials</em></a>) – Credentials creation payload (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(NewCredentials, status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.dns_api">
|
||
<span id="vmware-vmc-console-api-dns-api-module"></span><h2>vmware.vmc.console.api.dns_api module<a class="headerlink" href="#module-vmware.vmc.console.api.dns_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.dns_api.DnsApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.dns_api.</code><code class="sig-name descname">DnsApi</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.console.api.dns_api.DnsApi" 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.console.api.dns_api.DnsApi.orgs_org_sddcs_sddc_dns_private_put">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_dns_private_put</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.console.api.dns_api.DnsApi.orgs_org_sddcs_sddc_dns_private_put" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the DNS records of management VMs to use private IP addresses # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_dns_private_put(org, sddc, async_req=True)
|
||
>>> 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>Task
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.dns_api.DnsApi.orgs_org_sddcs_sddc_dns_private_put_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_dns_private_put_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.console.api.dns_api.DnsApi.orgs_org_sddcs_sddc_dns_private_put_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the DNS records of management VMs to use private IP addresses # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_dns_private_put_with_http_info(org, sddc, async_req=True)
|
||
>>> 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(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.console.api.dns_api.DnsApi.orgs_org_sddcs_sddc_dns_public_put">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_dns_public_put</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.console.api.dns_api.DnsApi.orgs_org_sddcs_sddc_dns_public_put" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the DNS records of management VMs to use public IP addresses # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_dns_public_put(org, sddc, async_req=True)
|
||
>>> 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>Task
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.dns_api.DnsApi.orgs_org_sddcs_sddc_dns_public_put_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_dns_public_put_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.console.api.dns_api.DnsApi.orgs_org_sddcs_sddc_dns_public_put_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the DNS records of management VMs to use public IP addresses # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_dns_public_put_with_http_info(org, sddc, async_req=True)
|
||
>>> 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(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.console.api.dns_api.DnsApi.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put</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">management_vm_id</span></em>, <em class="sig-param"><span class="n">ip_type</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.console.api.dns_api.DnsApi.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the DNS records of management VMs to use public or private IP addresses # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put(org, sddc, management_vm_id, ip_type, async_req=True)
|
||
>>> 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>management_vm_id</strong> (<em>str</em>) – the management VM ID (required)</p></li>
|
||
<li><p><strong>ip_type</strong> (<em>str</em>) – the ip type to associate with FQDN in DNS (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.console.api.dns_api.DnsApi.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put_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">management_vm_id</span></em>, <em class="sig-param"><span class="n">ip_type</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.console.api.dns_api.DnsApi.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the DNS records of management VMs to use public or private IP addresses # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put_with_http_info(org, sddc, management_vm_id, ip_type, async_req=True)
|
||
>>> 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>management_vm_id</strong> (<em>str</em>) – the management VM ID (required)</p></li>
|
||
<li><p><strong>ip_type</strong> (<em>str</em>) – the ip type to associate with FQDN in DNS (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>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.esx_api">
|
||
<span id="vmware-vmc-console-api-esx-api-module"></span><h2>vmware.vmc.console.api.esx_api module<a class="headerlink" href="#module-vmware.vmc.console.api.esx_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.esx_api.EsxApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.esx_api.</code><code class="sig-name descname">EsxApi</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.console.api.esx_api.EsxApi" 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.console.api.esx_api.EsxApi.orgs_org_sddcs_sddc_esxs_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_esxs_post</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">esx_config</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.console.api.esx_api.EsxApi.orgs_org_sddcs_sddc_esxs_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add/Remove one or more ESX hosts in the target cloud # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_esxs_post(org, sddc, esx_config, async_req=True)
|
||
>>> 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>esx_config</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.esx_config.EsxConfig" title="vmware.vmc.console.models.esx_config.EsxConfig"><em>EsxConfig</em></a>) – esxConfig (required)</p></li>
|
||
<li><p><strong>action</strong> (<em>str</em>) – If = ‘add’, will add the esx. If = ‘remove’, will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = ‘force-remove’, will delete the esx even if it can lead to data loss (This is an privileged operation). If = ‘addToAll’, will add esxs to all clusters in the SDDC (This is an privileged operation). If = ‘removeFromAll’, will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = ‘attach-diskgroup’, will attach the provided diskgroups to a given host (privileged). If = ‘detach-diskgroup’, will detach the diskgroups of a given host (privileged). Default behaviour is ‘add’</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.console.api.esx_api.EsxApi.orgs_org_sddcs_sddc_esxs_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_esxs_post_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">esx_config</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.console.api.esx_api.EsxApi.orgs_org_sddcs_sddc_esxs_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add/Remove one or more ESX hosts in the target cloud # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_esxs_post_with_http_info(org, sddc, esx_config, async_req=True)
|
||
>>> 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>esx_config</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.esx_config.EsxConfig" title="vmware.vmc.console.models.esx_config.EsxConfig"><em>EsxConfig</em></a>) – esxConfig (required)</p></li>
|
||
<li><p><strong>action</strong> (<em>str</em>) – If = ‘add’, will add the esx. If = ‘remove’, will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = ‘force-remove’, will delete the esx even if it can lead to data loss (This is an privileged operation). If = ‘addToAll’, will add esxs to all clusters in the SDDC (This is an privileged operation). If = ‘removeFromAll’, will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = ‘attach-diskgroup’, will attach the provided diskgroups to a given host (privileged). If = ‘detach-diskgroup’, will detach the diskgroups of a given host (privileged). Default behaviour is ‘add’</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>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.hcx_api">
|
||
<span id="vmware-vmc-console-api-hcx-api-module"></span><h2>vmware.vmc.console.api.hcx_api module<a class="headerlink" href="#module-vmware.vmc.console.api.hcx_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.hcx_api.HcxApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.hcx_api.</code><code class="sig-name descname">HcxApi</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.console.api.hcx_api.HcxApi" 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.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</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.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501</p>
|
||
<p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get(org, sddc_id, addon_type, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (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>list[NewCredentials]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_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">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</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.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501</p>
|
||
<p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info(org, sddc_id, addon_type, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (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(list[NewCredentials], 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.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</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.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get credential details by name # noqa: E501</p>
|
||
<p>Get credential details by name # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get(org, sddc_id, addon_type, name, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (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>NewCredentials
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_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">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</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.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get credential details by name # noqa: E501</p>
|
||
<p>Get credential details by name # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info(org, sddc_id, addon_type, name, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (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(NewCredentials, 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.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update credential details # noqa: E501</p>
|
||
<p>Update credential details # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put(org, sddc_id, addon_type, name, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.update_credentials.UpdateCredentials" title="vmware.vmc.console.models.update_credentials.UpdateCredentials"><em>UpdateCredentials</em></a>) – Credentials update payload (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>NewCredentials
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_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_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update credential details # noqa: E501</p>
|
||
<p>Update credential details # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info(org, sddc_id, addon_type, name, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.update_credentials.UpdateCredentials" title="vmware.vmc.console.models.update_credentials.UpdateCredentials"><em>UpdateCredentials</em></a>) – Credentials update payload (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(NewCredentials, 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.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Associate a new add on credentials with the SDDC such as HCX # noqa: E501</p>
|
||
<p>Associated a new add on credentials with the SDDC such as HCX # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post(org, sddc_id, addon_type, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.new_credentials.NewCredentials" title="vmware.vmc.console.models.new_credentials.NewCredentials"><em>NewCredentials</em></a>) – Credentials creation payload (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>NewCredentials
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_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_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.hcx_api.HcxApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Associate a new add on credentials with the SDDC such as HCX # noqa: E501</p>
|
||
<p>Associated a new add on credentials with the SDDC such as HCX # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info(org, sddc_id, addon_type, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.new_credentials.NewCredentials" title="vmware.vmc.console.models.new_credentials.NewCredentials"><em>NewCredentials</em></a>) – Credentials creation payload (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(NewCredentials, status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.locale_api">
|
||
<span id="vmware-vmc-console-api-locale-api-module"></span><h2>vmware.vmc.console.api.locale_api module<a class="headerlink" href="#module-vmware.vmc.console.api.locale_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.locale_api.LocaleApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.locale_api.</code><code class="sig-name descname">LocaleApi</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.console.api.locale_api.LocaleApi" 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.console.api.locale_api.LocaleApi.locale_post">
|
||
<code class="sig-name descname">locale_post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vmc_locale</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.console.api.locale_api.LocaleApi.locale_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set locale for the session # noqa: E501</p>
|
||
<p>Sets the locale for the session which is used for translating responses. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.locale_post(vmc_locale, async_req=True)
|
||
>>> 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>vmc_locale</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.vmc_locale.VmcLocale" title="vmware.vmc.console.models.vmc_locale.VmcLocale"><em>VmcLocale</em></a>) – The locale to be set. (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>VmcLocale
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.locale_api.LocaleApi.locale_post_with_http_info">
|
||
<code class="sig-name descname">locale_post_with_http_info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vmc_locale</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.console.api.locale_api.LocaleApi.locale_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set locale for the session # noqa: E501</p>
|
||
<p>Sets the locale for the session which is used for translating responses. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.locale_post_with_http_info(vmc_locale, async_req=True)
|
||
>>> 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>vmc_locale</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.vmc_locale.VmcLocale" title="vmware.vmc.console.models.vmc_locale.VmcLocale"><em>VmcLocale</em></a>) – The locale to be set. (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(VmcLocale, status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.msft_licensing_api">
|
||
<span id="vmware-vmc-console-api-msft-licensing-api-module"></span><h2>vmware.vmc.console.api.msft_licensing_api module<a class="headerlink" href="#module-vmware.vmc.console.api.msft_licensing_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.msft_licensing_api.MsftLicensingApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.msft_licensing_api.</code><code class="sig-name descname">MsftLicensingApi</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.console.api.msft_licensing_api.MsftLicensingApi" 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.console.api.msft_licensing_api.MsftLicensingApi.orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post</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">cluster</span></em>, <em class="sig-param"><span class="n">config_change</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.console.api.msft_licensing_api.MsftLicensingApi.orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post # noqa: E501</p>
|
||
<p>Sets the current Microsoft license status of the given SDDC’s cluster. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post(org, sddc, cluster, config_change, async_req=True)
|
||
>>> 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>cluster</strong> (<em>str</em>) – cluster identifier (required)</p></li>
|
||
<li><p><strong>config_change</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.msft_licensing_config.MsftLicensingConfig" title="vmware.vmc.console.models.msft_licensing_config.MsftLicensingConfig"><em>MsftLicensingConfig</em></a>) – The license data to set for the clusters. (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.console.api.msft_licensing_api.MsftLicensingApi.orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post_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">cluster</span></em>, <em class="sig-param"><span class="n">config_change</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.console.api.msft_licensing_api.MsftLicensingApi.orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post # noqa: E501</p>
|
||
<p>Sets the current Microsoft license status of the given SDDC’s cluster. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post_with_http_info(org, sddc, cluster, config_change, async_req=True)
|
||
>>> 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>cluster</strong> (<em>str</em>) – cluster identifier (required)</p></li>
|
||
<li><p><strong>config_change</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.msft_licensing_config.MsftLicensingConfig" title="vmware.vmc.console.models.msft_licensing_config.MsftLicensingConfig"><em>MsftLicensingConfig</em></a>) – The license data to set for the clusters. (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>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.orgs_api">
|
||
<span id="vmware-vmc-console-api-orgs-api-module"></span><h2>vmware.vmc.console.api.orgs_api module<a class="headerlink" href="#module-vmware.vmc.console.api.orgs_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.orgs_api.OrgsApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.orgs_api.</code><code class="sig-name descname">OrgsApi</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.console.api.orgs_api.OrgsApi" 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.console.api.orgs_api.OrgsApi.orgs_get">
|
||
<code class="sig-name descname">orgs_get</code><span class="sig-paren">(</span><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.console.api.orgs_api.OrgsApi.orgs_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get organizations associated with calling user. # noqa: E501</p>
|
||
<p>Return a list of all organizations the calling user (based on credential) is authorized on. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_get(async_req=True)
|
||
>>> 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>_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[Organization]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.orgs_api.OrgsApi.orgs_get_with_http_info">
|
||
<code class="sig-name descname">orgs_get_with_http_info</code><span class="sig-paren">(</span><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.console.api.orgs_api.OrgsApi.orgs_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get organizations associated with calling user. # noqa: E501</p>
|
||
<p>Return a list of all organizations the calling user (based on credential) is authorized on. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_get_with_http_info(async_req=True)
|
||
>>> 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>_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[Organization], 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.console.api.orgs_api.OrgsApi.orgs_org_get">
|
||
<code class="sig-name descname">orgs_org_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.orgs_api.OrgsApi.orgs_org_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get details of organization # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_get(org, async_req=True)
|
||
>>> 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>_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>Organization
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.orgs_api.OrgsApi.orgs_org_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.orgs_api.OrgsApi.orgs_org_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get details of organization # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_get_with_http_info(org, async_req=True)
|
||
>>> 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>_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(Organization, 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.console.api.orgs_api.OrgsApi.orgs_org_payment_methods_get">
|
||
<code class="sig-name descname">orgs_org_payment_methods_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.orgs_api.OrgsApi.orgs_org_payment_methods_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get payment methods of organization # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_payment_methods_get(org, async_req=True)
|
||
>>> 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>default_flag</strong> (<em>bool</em>) – When true, will only return default payment methods.</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[PaymentMethodInfo]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.orgs_api.OrgsApi.orgs_org_payment_methods_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_payment_methods_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.orgs_api.OrgsApi.orgs_org_payment_methods_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get payment methods of organization # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_payment_methods_get_with_http_info(org, async_req=True)
|
||
>>> 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>default_flag</strong> (<em>bool</em>) – When true, will only return default payment methods.</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[PaymentMethodInfo], 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.console.api.orgs_api.OrgsApi.orgs_org_providers_get">
|
||
<code class="sig-name descname">orgs_org_providers_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.orgs_api.OrgsApi.orgs_org_providers_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get enabled cloud providers for an organization # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_providers_get(org, async_req=True)
|
||
>>> 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>_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[AwsCloudProvider]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.orgs_api.OrgsApi.orgs_org_providers_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_providers_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.orgs_api.OrgsApi.orgs_org_providers_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get enabled cloud providers for an organization # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_providers_get_with_http_info(org, async_req=True)
|
||
>>> 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>_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[AwsCloudProvider], status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.reservations_api">
|
||
<span id="vmware-vmc-console-api-reservations-api-module"></span><h2>vmware.vmc.console.api.reservations_api module<a class="headerlink" href="#module-vmware.vmc.console.api.reservations_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.reservations_api.ReservationsApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.reservations_api.</code><code class="sig-name descname">ReservationsApi</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.console.api.reservations_api.ReservationsApi" 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.console.api.reservations_api.ReservationsApi.orgs_org_reservations_get">
|
||
<code class="sig-name descname">orgs_org_reservations_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.reservations_api.ReservationsApi.orgs_org_reservations_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get all reservations for this org # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_reservations_get(org, async_req=True)
|
||
>>> 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>_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[MaintenanceWindowEntry]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.reservations_api.ReservationsApi.orgs_org_reservations_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_reservations_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.reservations_api.ReservationsApi.orgs_org_reservations_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get all reservations for this org # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_reservations_get_with_http_info(org, async_req=True)
|
||
>>> 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>_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[MaintenanceWindowEntry], 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.console.api.reservations_api.ReservationsApi.orgs_org_reservations_reservation_mw_get">
|
||
<code class="sig-name descname">orgs_org_reservations_reservation_mw_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">reservation</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.console.api.reservations_api.ReservationsApi.orgs_org_reservations_reservation_mw_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>get the maintenance window for this 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
|
||
>>> thread = api.orgs_org_reservations_reservation_mw_get(org, reservation, async_req=True)
|
||
>>> 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>reservation</strong> (<em>str</em>) – Reservation 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>MaintenanceWindowGet
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.reservations_api.ReservationsApi.orgs_org_reservations_reservation_mw_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_reservations_reservation_mw_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">reservation</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.console.api.reservations_api.ReservationsApi.orgs_org_reservations_reservation_mw_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>get the maintenance window for this 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
|
||
>>> thread = api.orgs_org_reservations_reservation_mw_get_with_http_info(org, reservation, async_req=True)
|
||
>>> 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>reservation</strong> (<em>str</em>) – Reservation 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(MaintenanceWindowGet, 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.console.api.reservations_api.ReservationsApi.orgs_org_reservations_reservation_mw_put">
|
||
<code class="sig-name descname">orgs_org_reservations_reservation_mw_put</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">reservation</span></em>, <em class="sig-param"><span class="n">window</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.console.api.reservations_api.ReservationsApi.orgs_org_reservations_reservation_mw_put" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>update the maintenance window for this 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
|
||
>>> thread = api.orgs_org_reservations_reservation_mw_put(org, reservation, window, async_req=True)
|
||
>>> 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>reservation</strong> (<em>str</em>) – Reservation Identifier (required)</p></li>
|
||
<li><p><strong>window</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.maintenance_window.MaintenanceWindow" title="vmware.vmc.console.models.maintenance_window.MaintenanceWindow"><em>MaintenanceWindow</em></a>) – Maintenance Window (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>MaintenanceWindow
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.reservations_api.ReservationsApi.orgs_org_reservations_reservation_mw_put_with_http_info">
|
||
<code class="sig-name descname">orgs_org_reservations_reservation_mw_put_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">reservation</span></em>, <em class="sig-param"><span class="n">window</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.console.api.reservations_api.ReservationsApi.orgs_org_reservations_reservation_mw_put_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>update the maintenance window for this 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
|
||
>>> thread = api.orgs_org_reservations_reservation_mw_put_with_http_info(org, reservation, window, async_req=True)
|
||
>>> 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>reservation</strong> (<em>str</em>) – Reservation Identifier (required)</p></li>
|
||
<li><p><strong>window</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.maintenance_window.MaintenanceWindow" title="vmware.vmc.console.models.maintenance_window.MaintenanceWindow"><em>MaintenanceWindow</em></a>) – Maintenance Window (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(MaintenanceWindow, status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.sddc_api">
|
||
<span id="vmware-vmc-console-api-sddc-api-module"></span><h2>vmware.vmc.console.api.sddc_api module<a class="headerlink" href="#module-vmware.vmc.console.api.sddc_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.sddc_api.SddcApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.sddc_api.</code><code class="sig-name descname">SddcApi</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.console.api.sddc_api.SddcApi" 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.console.api.sddc_api.SddcApi.orgs_org_sddcs_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all the SDDCs of an organization # noqa: E501</p>
|
||
<p>List all the SDDCs of an organization # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_get(org, async_req=True)
|
||
>>> 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>include_deleted</strong> (<em>bool</em>) – When true, forces the result to also include deleted SDDCs.</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[Sddc]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all the SDDCs of an organization # noqa: E501</p>
|
||
<p>List all the SDDCs of an organization # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_get_with_http_info(org, async_req=True)
|
||
>>> 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>include_deleted</strong> (<em>bool</em>) – When true, forces the result to also include deleted SDDCs.</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[Sddc], 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.console.api.sddc_api.SddcApi.orgs_org_sddcs_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_config</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Provision SDDC # noqa: E501</p>
|
||
<p>Provision an SDDC in target cloud # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_post(org, sddc_config, async_req=True)
|
||
>>> 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_config</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.aws_sddc_config.AwsSddcConfig" title="vmware.vmc.console.models.aws_sddc_config.AwsSddcConfig"><em>AwsSddcConfig</em></a>) – sddcConfig (required)</p></li>
|
||
<li><p><strong>validate_only</strong> (<em>bool</em>) – When true, only validates the given sddc configuration without provisioning.</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_post_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_config</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Provision SDDC # noqa: E501</p>
|
||
<p>Provision an SDDC in target cloud # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_post_with_http_info(org, sddc_config, async_req=True)
|
||
>>> 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_config</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.aws_sddc_config.AwsSddcConfig" title="vmware.vmc.console.models.aws_sddc_config.AwsSddcConfig"><em>AwsSddcConfig</em></a>) – sddcConfig (required)</p></li>
|
||
<li><p><strong>validate_only</strong> (<em>bool</em>) – When true, only validates the given sddc configuration without provisioning.</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_provision_spec_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_provision_spec_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_provision_spec_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get sddc provision spec for an org # noqa: E501</p>
|
||
<p>Get sddc provision spec for an org # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_provision_spec_get(org, async_req=True)
|
||
>>> 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>_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>ProvisionSpec
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_provision_spec_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_provision_spec_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_provision_spec_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get sddc provision spec for an org # noqa: E501</p>
|
||
<p>Get sddc provision spec for an org # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_provision_spec_get_with_http_info(org, async_req=True)
|
||
>>> 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>_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(ProvisionSpec, 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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_clusters_cluster_delete">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_clusters_cluster_delete</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">cluster</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_clusters_cluster_delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete a cluster. # noqa: E501</p>
|
||
<p>This is a force operation which will delete the cluster even if there can be a data loss. Before calling this operation, all the VMs should be powered off. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_delete(org, sddc, cluster, async_req=True)
|
||
>>> 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>cluster</strong> (<em>str</em>) – cluster 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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_clusters_cluster_delete_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_clusters_cluster_delete_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">cluster</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_clusters_cluster_delete_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete a cluster. # noqa: E501</p>
|
||
<p>This is a force operation which will delete the cluster even if there can be a data loss. Before calling this operation, all the VMs should be powered off. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_delete_with_http_info(org, sddc, cluster, async_req=True)
|
||
>>> 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>cluster</strong> (<em>str</em>) – cluster 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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post</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">cluster</span></em>, <em class="sig-param"><span class="n">cluster_reconfigure_params</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Initiate a reconfiguration for the cluster. # noqa: E501</p>
|
||
<p>This reconfiguration will handle changing both the number of hosts and the cluster storage capacity. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post(org, sddc, cluster, cluster_reconfigure_params, async_req=True)
|
||
>>> 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>cluster</strong> (<em>str</em>) – cluster identifier (required)</p></li>
|
||
<li><p><strong>cluster_reconfigure_params</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.cluster_reconfigure_params.ClusterReconfigureParams" title="vmware.vmc.console.models.cluster_reconfigure_params.ClusterReconfigureParams"><em>ClusterReconfigureParams</em></a>) – clusterReconfigureParams (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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post_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">cluster</span></em>, <em class="sig-param"><span class="n">cluster_reconfigure_params</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Initiate a reconfiguration for the cluster. # noqa: E501</p>
|
||
<p>This reconfiguration will handle changing both the number of hosts and the cluster storage capacity. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post_with_http_info(org, sddc, cluster, cluster_reconfigure_params, async_req=True)
|
||
>>> 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>cluster</strong> (<em>str</em>) – cluster identifier (required)</p></li>
|
||
<li><p><strong>cluster_reconfigure_params</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.cluster_reconfigure_params.ClusterReconfigureParams" title="vmware.vmc.console.models.cluster_reconfigure_params.ClusterReconfigureParams"><em>ClusterReconfigureParams</em></a>) – clusterReconfigureParams (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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_clusters_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_clusters_post</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">cluster_config</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_clusters_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add a cluster in the target sddc. # noqa: E501</p>
|
||
<p>Creates a new cluster in customers sddcs with passed clusterConfig. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_clusters_post(org, sddc, cluster_config, async_req=True)
|
||
>>> 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>cluster_config</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.cluster_config.ClusterConfig" title="vmware.vmc.console.models.cluster_config.ClusterConfig"><em>ClusterConfig</em></a>) – clusterConfig (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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_clusters_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_clusters_post_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">cluster_config</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_clusters_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add a cluster in the target sddc. # noqa: E501</p>
|
||
<p>Creates a new cluster in customers sddcs with passed clusterConfig. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_clusters_post_with_http_info(org, sddc, cluster_config, async_req=True)
|
||
>>> 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>cluster_config</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.cluster_config.ClusterConfig" title="vmware.vmc.console.models.cluster_config.ClusterConfig"><em>ClusterConfig</em></a>) – clusterConfig (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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_convert_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_convert_post</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_convert_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Converts a one host SDDC to a four node DEFAULT SDDC. # noqa: E501</p>
|
||
<p>This API converts a one host SDDC to a four node DEFAULT SDDC. It takes care of configuring and upgrading the vCenter configurations on the SDDC for high availability and data redundancy. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_convert_post(org, sddc, async_req=True)
|
||
>>> 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>Task
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_convert_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_convert_post_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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_convert_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Converts a one host SDDC to a four node DEFAULT SDDC. # noqa: E501</p>
|
||
<p>This API converts a one host SDDC to a four node DEFAULT SDDC. It takes care of configuring and upgrading the vCenter configurations on the SDDC for high availability and data redundancy. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_convert_post_with_http_info(org, sddc, async_req=True)
|
||
>>> 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(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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_delete">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_delete</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete 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
|
||
>>> thread = api.orgs_org_sddcs_sddc_delete(org, sddc, async_req=True)
|
||
>>> 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>retain_configuration</strong> (<em>bool</em>) – If = ‘true’, the SDDC’s configuration is retained as a template for later use. This flag is applicable only to SDDCs in ACTIVE state.</p></li>
|
||
<li><p><strong>template_name</strong> (<em>str</em>) – Only applicable when retainConfiguration is also set to ‘true’. When set, this value will be used as the name of the SDDC configuration template generated.</p></li>
|
||
<li><p><strong>force</strong> (<em>bool</em>) – If = true, will delete forcefully. Beware: do not use the force flag if there is a chance an active provisioning or deleting task is running against this SDDC. This option is restricted.</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_delete_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_delete_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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_delete_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete 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
|
||
>>> thread = api.orgs_org_sddcs_sddc_delete_with_http_info(org, sddc, async_req=True)
|
||
>>> 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>retain_configuration</strong> (<em>bool</em>) – If = ‘true’, the SDDC’s configuration is retained as a template for later use. This flag is applicable only to SDDCs in ACTIVE state.</p></li>
|
||
<li><p><strong>template_name</strong> (<em>str</em>) – Only applicable when retainConfiguration is also set to ‘true’. When set, this value will be used as the name of the SDDC configuration template generated.</p></li>
|
||
<li><p><strong>force</strong> (<em>bool</em>) – If = true, will delete forcefully. Beware: do not use the force flag if there is a chance an active provisioning or deleting task is running against this SDDC. This option is restricted.</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_dns_private_put">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_dns_private_put</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_dns_private_put" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the DNS records of management VMs to use private IP addresses # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_dns_private_put(org, sddc, async_req=True)
|
||
>>> 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>Task
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_dns_private_put_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_dns_private_put_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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_dns_private_put_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the DNS records of management VMs to use private IP addresses # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_dns_private_put_with_http_info(org, sddc, async_req=True)
|
||
>>> 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(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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_dns_public_put">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_dns_public_put</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_dns_public_put" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the DNS records of management VMs to use public IP addresses # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_dns_public_put(org, sddc, async_req=True)
|
||
>>> 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>Task
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_dns_public_put_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_dns_public_put_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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_dns_public_put_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the DNS records of management VMs to use public IP addresses # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_dns_public_put_with_http_info(org, sddc, async_req=True)
|
||
>>> 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(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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_esxs_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_esxs_post</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">esx_config</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_esxs_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add/Remove one or more ESX hosts in the target cloud # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_esxs_post(org, sddc, esx_config, async_req=True)
|
||
>>> 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>esx_config</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.esx_config.EsxConfig" title="vmware.vmc.console.models.esx_config.EsxConfig"><em>EsxConfig</em></a>) – esxConfig (required)</p></li>
|
||
<li><p><strong>action</strong> (<em>str</em>) – If = ‘add’, will add the esx. If = ‘remove’, will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = ‘force-remove’, will delete the esx even if it can lead to data loss (This is an privileged operation). If = ‘addToAll’, will add esxs to all clusters in the SDDC (This is an privileged operation). If = ‘removeFromAll’, will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = ‘attach-diskgroup’, will attach the provided diskgroups to a given host (privileged). If = ‘detach-diskgroup’, will detach the diskgroups of a given host (privileged). Default behaviour is ‘add’</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_esxs_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_esxs_post_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">esx_config</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_esxs_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add/Remove one or more ESX hosts in the target cloud # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_esxs_post_with_http_info(org, sddc, esx_config, async_req=True)
|
||
>>> 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>esx_config</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.esx_config.EsxConfig" title="vmware.vmc.console.models.esx_config.EsxConfig"><em>EsxConfig</em></a>) – esxConfig (required)</p></li>
|
||
<li><p><strong>action</strong> (<em>str</em>) – If = ‘add’, will add the esx. If = ‘remove’, will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = ‘force-remove’, will delete the esx even if it can lead to data loss (This is an privileged operation). If = ‘addToAll’, will add esxs to all clusters in the SDDC (This is an privileged operation). If = ‘removeFromAll’, will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = ‘attach-diskgroup’, will attach the provided diskgroups to a given host (privileged). If = ‘detach-diskgroup’, will detach the diskgroups of a given host (privileged). Default behaviour is ‘add’</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_get</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get SDDC # noqa: E501</p>
|
||
<p>Get SDDC # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_get(org, sddc, async_req=True)
|
||
>>> 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>Sddc
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_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">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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get SDDC # noqa: E501</p>
|
||
<p>Get SDDC # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_get_with_http_info(org, sddc, async_req=True)
|
||
>>> 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(Sddc, 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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501</p>
|
||
<p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get(org, sddc_id, addon_type, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (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>list[NewCredentials]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_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">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501</p>
|
||
<p>List all the credentials assoicated with an addon type with in a SDDC # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info(org, sddc_id, addon_type, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (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(list[NewCredentials], 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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get credential details by name # noqa: E501</p>
|
||
<p>Get credential details by name # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get(org, sddc_id, addon_type, name, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (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>NewCredentials
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_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">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get credential details by name # noqa: E501</p>
|
||
<p>Get credential details by name # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info(org, sddc_id, addon_type, name, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (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(NewCredentials, 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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update credential details # noqa: E501</p>
|
||
<p>Update credential details # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put(org, sddc_id, addon_type, name, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.update_credentials.UpdateCredentials" title="vmware.vmc.console.models.update_credentials.UpdateCredentials"><em>UpdateCredentials</em></a>) – Credentials update payload (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>NewCredentials
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_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_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update credential details # noqa: E501</p>
|
||
<p>Update credential details # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info(org, sddc_id, addon_type, name, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>name</strong> (<em>str</em>) – name of the credentials (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.update_credentials.UpdateCredentials" title="vmware.vmc.console.models.update_credentials.UpdateCredentials"><em>UpdateCredentials</em></a>) – Credentials update payload (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(NewCredentials, 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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Associate a new add on credentials with the SDDC such as HCX # noqa: E501</p>
|
||
<p>Associated a new add on credentials with the SDDC such as HCX # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post(org, sddc_id, addon_type, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.new_credentials.NewCredentials" title="vmware.vmc.console.models.new_credentials.NewCredentials"><em>NewCredentials</em></a>) – Credentials creation payload (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>NewCredentials
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_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_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">credentials</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Associate a new add on credentials with the SDDC such as HCX # noqa: E501</p>
|
||
<p>Associated a new add on credentials with the SDDC such as HCX # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info(org, sddc_id, addon_type, credentials, async_req=True)
|
||
>>> 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>) – Org id of the associated SDDC (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<em>str</em>) – Id of the SDDC (required)</p></li>
|
||
<li><p><strong>addon_type</strong> (<em>str</em>) – Add on type (required)</p></li>
|
||
<li><p><strong>credentials</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.new_credentials.NewCredentials" title="vmware.vmc.console.models.new_credentials.NewCredentials"><em>NewCredentials</em></a>) – Credentials creation payload (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(NewCredentials, 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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put</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">management_vm_id</span></em>, <em class="sig-param"><span class="n">ip_type</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the DNS records of management VMs to use public or private IP addresses # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put(org, sddc, management_vm_id, ip_type, async_req=True)
|
||
>>> 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>management_vm_id</strong> (<em>str</em>) – the management VM ID (required)</p></li>
|
||
<li><p><strong>ip_type</strong> (<em>str</em>) – the ip type to associate with FQDN in DNS (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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put_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">management_vm_id</span></em>, <em class="sig-param"><span class="n">ip_type</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the DNS records of management VMs to use public or private IP addresses # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put_with_http_info(org, sddc, management_vm_id, ip_type, async_req=True)
|
||
>>> 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>management_vm_id</strong> (<em>str</em>) – the management VM ID (required)</p></li>
|
||
<li><p><strong>ip_type</strong> (<em>str</em>) – the ip type to associate with FQDN in DNS (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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_patch">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_patch</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">sddc_patch_request</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_patch" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Patch 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
|
||
>>> thread = api.orgs_org_sddcs_sddc_patch(org, sddc, sddc_patch_request, async_req=True)
|
||
>>> 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>sddc_patch_request</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.sddc_patch_request.SddcPatchRequest" title="vmware.vmc.console.models.sddc_patch_request.SddcPatchRequest"><em>SddcPatchRequest</em></a>) – Patch request for the SDDC (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>Sddc
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_patch_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_patch_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">sddc_patch_request</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_patch_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Patch 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
|
||
>>> thread = api.orgs_org_sddcs_sddc_patch_with_http_info(org, sddc, sddc_patch_request, async_req=True)
|
||
>>> 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>sddc_patch_request</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.sddc_patch_request.SddcPatchRequest" title="vmware.vmc.console.models.sddc_patch_request.SddcPatchRequest"><em>SddcPatchRequest</em></a>) – Patch request for the SDDC (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(Sddc, 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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_primarycluster_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_primarycluster_get</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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_primarycluster_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get a primary cluster in the target sddc # noqa: E501</p>
|
||
<p>Retrieves the primary cluster in provided customer sddc UUID # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_primarycluster_get(org, sddc, async_req=True)
|
||
>>> 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>Cluster
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_primarycluster_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_primarycluster_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">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.console.api.sddc_api.SddcApi.orgs_org_sddcs_sddc_primarycluster_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get a primary cluster in the target sddc # noqa: E501</p>
|
||
<p>Retrieves the primary cluster in provided customer sddc UUID # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_primarycluster_get_with_http_info(org, sddc, async_req=True)
|
||
>>> 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(Cluster, status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.sddc_template_api">
|
||
<span id="vmware-vmc-console-api-sddc-template-api-module"></span><h2>vmware.vmc.console.api.sddc_template_api module<a class="headerlink" href="#module-vmware.vmc.console.api.sddc_template_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.sddc_template_api.SddcTemplateApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.sddc_template_api.</code><code class="sig-name descname">SddcTemplateApi</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.console.api.sddc_template_api.SddcTemplateApi" 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.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddc_templates_get">
|
||
<code class="sig-name descname">orgs_org_sddc_templates_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddc_templates_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all available SDDC configuration templates in an organization # noqa: E501</p>
|
||
<p>List all available SDDC configuration templates in an organization # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddc_templates_get(org, async_req=True)
|
||
>>> 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>_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[SddcTemplate]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddc_templates_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddc_templates_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddc_templates_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all available SDDC configuration templates in an organization # noqa: E501</p>
|
||
<p>List all available SDDC configuration templates in an organization # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddc_templates_get_with_http_info(org, async_req=True)
|
||
>>> 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>_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[SddcTemplate], 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.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddc_templates_template_id_delete">
|
||
<code class="sig-name descname">orgs_org_sddc_templates_template_id_delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">template_id</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.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddc_templates_template_id_delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete SDDC template identified by given id. # noqa: E501</p>
|
||
<p>Delete SDDC template identified by given id. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddc_templates_template_id_delete(org, template_id, async_req=True)
|
||
>>> 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>template_id</strong> (<em>str</em>) – SDDC Template 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.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddc_templates_template_id_delete_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddc_templates_template_id_delete_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">template_id</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.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddc_templates_template_id_delete_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete SDDC template identified by given id. # noqa: E501</p>
|
||
<p>Delete SDDC template identified by given id. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddc_templates_template_id_delete_with_http_info(org, template_id, async_req=True)
|
||
>>> 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>template_id</strong> (<em>str</em>) – SDDC Template 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.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddc_templates_template_id_get">
|
||
<code class="sig-name descname">orgs_org_sddc_templates_template_id_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">template_id</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.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddc_templates_template_id_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get configuration template by given template id. # noqa: E501</p>
|
||
<p>Get configuration template by given template id. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddc_templates_template_id_get(org, template_id, async_req=True)
|
||
>>> 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>template_id</strong> (<em>str</em>) – SDDC Template 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>SddcTemplate
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddc_templates_template_id_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddc_templates_template_id_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">template_id</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.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddc_templates_template_id_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get configuration template by given template id. # noqa: E501</p>
|
||
<p>Get configuration template by given template id. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddc_templates_template_id_get_with_http_info(org, template_id, async_req=True)
|
||
>>> 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>template_id</strong> (<em>str</em>) – SDDC Template 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(SddcTemplate, 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.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddcs_sddc_sddc_template_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_sddc_template_get</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.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddcs_sddc_sddc_template_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get configuration template for an SDDC # noqa: E501</p>
|
||
<p>Get configuration template for an SDDC # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_sddc_template_get(org, sddc, async_req=True)
|
||
>>> 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>SddcTemplate
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddcs_sddc_sddc_template_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_sddc_template_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">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.console.api.sddc_template_api.SddcTemplateApi.orgs_org_sddcs_sddc_sddc_template_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get configuration template for an SDDC # noqa: E501</p>
|
||
<p>Get configuration template for an SDDC # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_sddc_template_get_with_http_info(org, sddc, async_req=True)
|
||
>>> 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(SddcTemplate, status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.storage_api">
|
||
<span id="vmware-vmc-console-api-storage-api-module"></span><h2>vmware.vmc.console.api.storage_api module<a class="headerlink" href="#module-vmware.vmc.console.api.storage_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.storage_api.StorageApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.storage_api.</code><code class="sig-name descname">StorageApi</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.console.api.storage_api.StorageApi" 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.console.api.storage_api.StorageApi.orgs_org_storage_cluster_constraints_get">
|
||
<code class="sig-name descname">orgs_org_storage_cluster_constraints_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">provider</span></em>, <em class="sig-param"><span class="n">num_hosts</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.console.api.storage_api.StorageApi.orgs_org_storage_cluster_constraints_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get constraints on cluster storage size for EBS-backed clusters. # noqa: E501</p>
|
||
<p>Get constraints on cluster storage size for EBS-backed clusters. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_storage_cluster_constraints_get(org, provider, num_hosts, async_req=True)
|
||
>>> 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>provider</strong> (<em>str</em>) – Cloud storage provider ID (example AWS) (required)</p></li>
|
||
<li><p><strong>num_hosts</strong> (<em>int</em>) – Number of hosts in cluster (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>VsanConfigConstraints
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.storage_api.StorageApi.orgs_org_storage_cluster_constraints_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_storage_cluster_constraints_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">provider</span></em>, <em class="sig-param"><span class="n">num_hosts</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.console.api.storage_api.StorageApi.orgs_org_storage_cluster_constraints_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get constraints on cluster storage size for EBS-backed clusters. # noqa: E501</p>
|
||
<p>Get constraints on cluster storage size for EBS-backed clusters. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_storage_cluster_constraints_get_with_http_info(org, provider, num_hosts, async_req=True)
|
||
>>> 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>provider</strong> (<em>str</em>) – Cloud storage provider ID (example AWS) (required)</p></li>
|
||
<li><p><strong>num_hosts</strong> (<em>int</em>) – Number of hosts in cluster (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(VsanConfigConstraints, status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.subscription_api">
|
||
<span id="vmware-vmc-console-api-subscription-api-module"></span><h2>vmware.vmc.console.api.subscription_api module<a class="headerlink" href="#module-vmware.vmc.console.api.subscription_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.subscription_api.SubscriptionApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.subscription_api.</code><code class="sig-name descname">SubscriptionApi</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.console.api.subscription_api.SubscriptionApi" 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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_get">
|
||
<code class="sig-name descname">orgs_org_subscriptions_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get all subscriptions # noqa: E501</p>
|
||
<p>Returns all subscriptions for a given org id # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_subscriptions_get(org, async_req=True)
|
||
>>> 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>offer_type</strong> (<em>str</em>) – Offer Type * <cite>ON_DEMAND</cite> - on-demand subscription * <cite>TERM</cite> - term subscription * All subscriptions if not specified</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[SubscriptionDetails]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_subscriptions_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get all subscriptions # noqa: E501</p>
|
||
<p>Returns all subscriptions for a given org id # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_subscriptions_get_with_http_info(org, async_req=True)
|
||
>>> 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>offer_type</strong> (<em>str</em>) – Offer Type * <cite>ON_DEMAND</cite> - on-demand subscription * <cite>TERM</cite> - term subscription * All subscriptions if not specified</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[SubscriptionDetails], 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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_offer_instances_get">
|
||
<code class="sig-name descname">orgs_org_subscriptions_offer_instances_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">region</span></em>, <em class="sig-param"><span class="n">product_type</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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_offer_instances_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all offers available for the specific product type in the specific region # noqa: E501</p>
|
||
<p>List all offers available for the specific product type in the specific region # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_subscriptions_offer_instances_get(org, region, product_type, async_req=True)
|
||
>>> 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>region</strong> (<em>str</em>) – Region for the offer (required)</p></li>
|
||
<li><p><strong>product_type</strong> (<em>str</em>) – Type of the product in offers. <em>This has been deprecated</em>. Please use product & type parameters (required)</p></li>
|
||
<li><p><strong>product</strong> (<em>str</em>) – The product that you are trying to purchase, eg. host. This needs to be accompanied by the type parameter</p></li>
|
||
<li><p><strong>type</strong> (<em>str</em>) – The type/flavor of the product you are trying it purchase,eg. an <cite>r5.metal</cite> host. This needs to be accompanied by the product parameter.</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>OfferInstancesHolder
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_offer_instances_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_subscriptions_offer_instances_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">region</span></em>, <em class="sig-param"><span class="n">product_type</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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_offer_instances_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all offers available for the specific product type in the specific region # noqa: E501</p>
|
||
<p>List all offers available for the specific product type in the specific region # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_subscriptions_offer_instances_get_with_http_info(org, region, product_type, async_req=True)
|
||
>>> 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>region</strong> (<em>str</em>) – Region for the offer (required)</p></li>
|
||
<li><p><strong>product_type</strong> (<em>str</em>) – Type of the product in offers. <em>This has been deprecated</em>. Please use product & type parameters (required)</p></li>
|
||
<li><p><strong>product</strong> (<em>str</em>) – The product that you are trying to purchase, eg. host. This needs to be accompanied by the type parameter</p></li>
|
||
<li><p><strong>type</strong> (<em>str</em>) – The type/flavor of the product you are trying it purchase,eg. an <cite>r5.metal</cite> host. This needs to be accompanied by the product parameter.</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(OfferInstancesHolder, 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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_post">
|
||
<code class="sig-name descname">orgs_org_subscriptions_post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">subscription_request</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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a subscription # noqa: E501</p>
|
||
<p>Initiates the creation of a subscription # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_subscriptions_post(org, subscription_request, async_req=True)
|
||
>>> 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>subscription_request</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.subscription_request.SubscriptionRequest" title="vmware.vmc.console.models.subscription_request.SubscriptionRequest"><em>SubscriptionRequest</em></a>) – subscriptionRequest (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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_subscriptions_post_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">subscription_request</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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a subscription # noqa: E501</p>
|
||
<p>Initiates the creation of a subscription # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_subscriptions_post_with_http_info(org, subscription_request, async_req=True)
|
||
>>> 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>subscription_request</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.subscription_request.SubscriptionRequest" title="vmware.vmc.console.models.subscription_request.SubscriptionRequest"><em>SubscriptionRequest</em></a>) – subscriptionRequest (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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_products_get">
|
||
<code class="sig-name descname">orgs_org_subscriptions_products_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_products_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List of all the products that are available for purchase. # noqa: E501</p>
|
||
<p>List of all the products that are available for purchase. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_subscriptions_products_get(org, async_req=True)
|
||
>>> 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>_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[SubscriptionProducts]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_products_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_subscriptions_products_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_products_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List of all the products that are available for purchase. # noqa: E501</p>
|
||
<p>List of all the products that are available for purchase. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_subscriptions_products_get_with_http_info(org, async_req=True)
|
||
>>> 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>_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[SubscriptionProducts], 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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_subscription_get">
|
||
<code class="sig-name descname">orgs_org_subscriptions_subscription_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">subscription</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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_subscription_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get a subscription # noqa: E501</p>
|
||
<p>Get subscription details for a given subscription id # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_subscriptions_subscription_get(org, subscription, async_req=True)
|
||
>>> 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>subscription</strong> (<em>str</em>) – SubscriptionId for an sddc. (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>SubscriptionDetails
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_subscription_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_subscriptions_subscription_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">subscription</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.console.api.subscription_api.SubscriptionApi.orgs_org_subscriptions_subscription_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get a subscription # noqa: E501</p>
|
||
<p>Get subscription details for a given subscription id # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_subscriptions_subscription_get_with_http_info(org, subscription, async_req=True)
|
||
>>> 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>subscription</strong> (<em>str</em>) – SubscriptionId for an sddc. (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(SubscriptionDetails, status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.task_api">
|
||
<span id="vmware-vmc-console-api-task-api-module"></span><h2>vmware.vmc.console.api.task_api module<a class="headerlink" href="#module-vmware.vmc.console.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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.task_api.TaskApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.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.console.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.console.api.task_api.TaskApi.orgs_org_tasks_get">
|
||
<code class="sig-name descname">orgs_org_tasks_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.task_api.TaskApi.orgs_org_tasks_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all tasks for organization # noqa: E501</p>
|
||
<p>List all tasks with optional filtering. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_tasks_get(org, async_req=True)
|
||
>>> 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>filter</strong> (<em>str</em>) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’, ‘ge’, ‘mul’, ‘div’, ‘mod’, ‘sub’, ‘add’ Unary Operators: ‘not’, ‘-‘ (minus) String Operators: ‘startswith’, ‘endswith’, ‘length’, ‘contains’, ‘tolower’, ‘toupper’, Nested attributes are composed using ‘.’ Dates must be formatted as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single quotes, escape single quote with two single quotes The special literal ‘created’ will be mapped to the time the resource was first created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - $filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) and (sddc.status eq ‘READY’)</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[Task]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.task_api.TaskApi.orgs_org_tasks_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_tasks_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.task_api.TaskApi.orgs_org_tasks_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all tasks for organization # noqa: E501</p>
|
||
<p>List all tasks with optional filtering. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_tasks_get_with_http_info(org, async_req=True)
|
||
>>> 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>filter</strong> (<em>str</em>) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’, ‘ge’, ‘mul’, ‘div’, ‘mod’, ‘sub’, ‘add’ Unary Operators: ‘not’, ‘-‘ (minus) String Operators: ‘startswith’, ‘endswith’, ‘length’, ‘contains’, ‘tolower’, ‘toupper’, Nested attributes are composed using ‘.’ Dates must be formatted as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single quotes, escape single quote with two single quotes The special literal ‘created’ will be mapped to the time the resource was first created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - $filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) and (sddc.status eq ‘READY’)</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[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.console.api.task_api.TaskApi.orgs_org_tasks_task_get">
|
||
<code class="sig-name descname">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.console.api.task_api.TaskApi.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
|
||
>>> thread = api.orgs_org_tasks_task_get(org, task, async_req=True)
|
||
>>> 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.console.api.task_api.TaskApi.orgs_org_tasks_task_get_with_http_info">
|
||
<code class="sig-name descname">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.console.api.task_api.TaskApi.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
|
||
>>> thread = api.orgs_org_tasks_task_get_with_http_info(org, task, async_req=True)
|
||
>>> 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>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.task_api.TaskApi.orgs_org_tasks_task_post">
|
||
<code class="sig-name descname">orgs_org_tasks_task_post</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.console.api.task_api.TaskApi.orgs_org_tasks_task_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Modify an existing task # noqa: E501</p>
|
||
<p>Request that a running task be canceled. This is advisory only, some tasks may not be cancelable, and some tasks might take an arbitrary amount of time to respond to a cancelation request. The task must be monitored to determine subsequent status. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_tasks_task_post(org, task, async_req=True)
|
||
>>> 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>action</strong> (<em>str</em>) – If = ‘cancel’, task will be canceled</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.console.api.task_api.TaskApi.orgs_org_tasks_task_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_tasks_task_post_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.console.api.task_api.TaskApi.orgs_org_tasks_task_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Modify an existing task # noqa: E501</p>
|
||
<p>Request that a running task be canceled. This is advisory only, some tasks may not be cancelable, and some tasks might take an arbitrary amount of time to respond to a cancelation request. The task must be monitored to determine subsequent status. # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_tasks_task_post_with_http_info(org, task, async_req=True)
|
||
>>> 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>action</strong> (<em>str</em>) – If = ‘cancel’, task will be canceled</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>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.tbrs_api">
|
||
<span id="vmware-vmc-console-api-tbrs-api-module"></span><h2>vmware.vmc.console.api.tbrs_api module<a class="headerlink" href="#module-vmware.vmc.console.api.tbrs_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.tbrs_api.TbrsApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.tbrs_api.</code><code class="sig-name descname">TbrsApi</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.console.api.tbrs_api.TbrsApi" 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.console.api.tbrs_api.TbrsApi.orgs_org_tbrs_reservation_post">
|
||
<code class="sig-name descname">orgs_org_tbrs_reservation_post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.tbrs_api.TbrsApi.orgs_org_tbrs_reservation_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>orgs_org_tbrs_reservation_post # noqa: E501</p>
|
||
<p>Retreive all reservations for all SDDCs in this org # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_tbrs_reservation_post(org, async_req=True)
|
||
>>> 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_state</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.sddc_state_request.SddcStateRequest" title="vmware.vmc.console.models.sddc_state_request.SddcStateRequest"><em>SddcStateRequest</em></a>) – SDDCs and/or states to query</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>dict(str, list[ReservationWindow])
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.tbrs_api.TbrsApi.orgs_org_tbrs_reservation_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_tbrs_reservation_post_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.tbrs_api.TbrsApi.orgs_org_tbrs_reservation_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>orgs_org_tbrs_reservation_post # noqa: E501</p>
|
||
<p>Retreive all reservations for all SDDCs in this org # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_tbrs_reservation_post_with_http_info(org, async_req=True)
|
||
>>> 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_state</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.sddc_state_request.SddcStateRequest" title="vmware.vmc.console.models.sddc_state_request.SddcStateRequest"><em>SddcStateRequest</em></a>) – SDDCs and/or states to query</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(dict(str, list[ReservationWindow]), 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.console.api.tbrs_api.TbrsApi.orgs_org_tbrs_support_window_get">
|
||
<code class="sig-name descname">orgs_org_tbrs_support_window_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</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.console.api.tbrs_api.TbrsApi.orgs_org_tbrs_support_window_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>orgs_org_tbrs_support_window_get # noqa: E501</p>
|
||
<p>Get all available support windows # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_tbrs_support_window_get(org, async_req=True)
|
||
>>> 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>minimum_seats_available</strong> (<em>int</em>) – minimum seats available (used as a filter)</p></li>
|
||
<li><p><strong>created_by</strong> (<em>str</em>) – user name which was used to create the support window (used as a filter)</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[SupportWindow]
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.tbrs_api.TbrsApi.orgs_org_tbrs_support_window_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_tbrs_support_window_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="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api.tbrs_api.TbrsApi.orgs_org_tbrs_support_window_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>orgs_org_tbrs_support_window_get # noqa: E501</p>
|
||
<p>Get all available support windows # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_tbrs_support_window_get_with_http_info(org, async_req=True)
|
||
>>> 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>minimum_seats_available</strong> (<em>int</em>) – minimum seats available (used as a filter)</p></li>
|
||
<li><p><strong>created_by</strong> (<em>str</em>) – user name which was used to create the support window (used as a filter)</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[SupportWindow], 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.console.api.tbrs_api.TbrsApi.orgs_org_tbrs_support_window_id_put">
|
||
<code class="sig-name descname">orgs_org_tbrs_support_window_id_put</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">sddc_id</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.console.api.tbrs_api.TbrsApi.orgs_org_tbrs_support_window_id_put" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>orgs_org_tbrs_support_window_id_put # noqa: E501</p>
|
||
<p>Move Sddc to new support window # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_tbrs_support_window_id_put(org, id, sddc_id, async_req=True)
|
||
>>> 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>id</strong> (<em>str</em>) – Target Support Window ID (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.sddc_id.SddcId" title="vmware.vmc.console.models.sddc_id.SddcId"><em>SddcId</em></a>) – SDDC to move (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>SupportWindowId
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.tbrs_api.TbrsApi.orgs_org_tbrs_support_window_id_put_with_http_info">
|
||
<code class="sig-name descname">orgs_org_tbrs_support_window_id_put_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">id</span></em>, <em class="sig-param"><span class="n">sddc_id</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.console.api.tbrs_api.TbrsApi.orgs_org_tbrs_support_window_id_put_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>orgs_org_tbrs_support_window_id_put # noqa: E501</p>
|
||
<p>Move Sddc to new support window # noqa: E501
|
||
This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_tbrs_support_window_id_put_with_http_info(org, id, sddc_id, async_req=True)
|
||
>>> 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>id</strong> (<em>str</em>) – Target Support Window ID (required)</p></li>
|
||
<li><p><strong>sddc_id</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.sddc_id.SddcId" title="vmware.vmc.console.models.sddc_id.SddcId"><em>SddcId</em></a>) – SDDC to move (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(SupportWindowId, status_code(int), headers(HTTPHeaderDict))
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api.troubleshooting_api">
|
||
<span id="vmware-vmc-console-api-troubleshooting-api-module"></span><h2>vmware.vmc.console.api.troubleshooting_api module<a class="headerlink" href="#module-vmware.vmc.console.api.troubleshooting_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>VMware Cloud APIs</strong></p>
|
||
<p>The version of the OpenAPI document: 1.0
|
||
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</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.console.api.troubleshooting_api.TroubleshootingApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api.troubleshooting_api.</code><code class="sig-name descname">TroubleshootingApi</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.console.api.troubleshooting_api.TroubleshootingApi" 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.console.api.troubleshooting_api.TroubleshootingApi.orgs_org_sddcs_sddc_networking_connectivity_tests_get">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_networking_connectivity_tests_get</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.console.api.troubleshooting_api.TroubleshootingApi.orgs_org_sddcs_sddc_networking_connectivity_tests_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieve metadata for connectivity tests. # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_networking_connectivity_tests_get(org, sddc, async_req=True)
|
||
>>> 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>ConnectivityValidationGroups
|
||
If the method is called asynchronously,
|
||
returns the request thread.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="vmware.vmc.console.api.troubleshooting_api.TroubleshootingApi.orgs_org_sddcs_sddc_networking_connectivity_tests_get_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_networking_connectivity_tests_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">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.console.api.troubleshooting_api.TroubleshootingApi.orgs_org_sddcs_sddc_networking_connectivity_tests_get_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieve metadata for connectivity tests. # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_networking_connectivity_tests_get_with_http_info(org, sddc, async_req=True)
|
||
>>> 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(ConnectivityValidationGroups, 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.console.api.troubleshooting_api.TroubleshootingApi.orgs_org_sddcs_sddc_networking_connectivity_tests_post">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_networking_connectivity_tests_post</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">action</span></em>, <em class="sig-param"><span class="n">request_info</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.console.api.troubleshooting_api.TroubleshootingApi.orgs_org_sddcs_sddc_networking_connectivity_tests_post" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ConnectivityValidationGroupResultWrapper will be available at task.params[‘test_result’]. # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_networking_connectivity_tests_post(org, sddc, action, request_info, async_req=True)
|
||
>>> 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>action</strong> (<em>str</em>) – If = ‘start’, start connectivity tests. (required)</p></li>
|
||
<li><p><strong>request_info</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.connectivity_validation_group.ConnectivityValidationGroup" title="vmware.vmc.console.models.connectivity_validation_group.ConnectivityValidationGroup"><em>ConnectivityValidationGroup</em></a>) – request information (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.console.api.troubleshooting_api.TroubleshootingApi.orgs_org_sddcs_sddc_networking_connectivity_tests_post_with_http_info">
|
||
<code class="sig-name descname">orgs_org_sddcs_sddc_networking_connectivity_tests_post_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">action</span></em>, <em class="sig-param"><span class="n">request_info</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.console.api.troubleshooting_api.TroubleshootingApi.orgs_org_sddcs_sddc_networking_connectivity_tests_post_with_http_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ConnectivityValidationGroupResultWrapper will be available at task.params[‘test_result’]. # noqa: E501</p>
|
||
<p>This method makes a synchronous HTTP request by default. To make an
|
||
asynchronous HTTP request, please pass async_req=True
|
||
>>> thread = api.orgs_org_sddcs_sddc_networking_connectivity_tests_post_with_http_info(org, sddc, action, request_info, async_req=True)
|
||
>>> 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>action</strong> (<em>str</em>) – If = ‘start’, start connectivity tests. (required)</p></li>
|
||
<li><p><strong>request_info</strong> (<a class="reference internal" href="vmware.vmc.console.models.html#vmware.vmc.console.models.connectivity_validation_group.ConnectivityValidationGroup" title="vmware.vmc.console.models.connectivity_validation_group.ConnectivityValidationGroup"><em>ConnectivityValidationGroup</em></a>) – request information (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>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vmc.console.api">
|
||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-vmware.vmc.console.api" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="vmware.vmc.console.models.html" class="btn btn-neutral float-right" title="vmware.vmc.console.models package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="vmware.vmc.console.html" class="btn btn-neutral float-left" title="vmware.vmc.console package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
|
||
© Copyright 2020, VMware Inc.
|
||
|
||
</p>
|
||
</div>
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |