Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-23 09:59:59 -05:00
Code
83bd922c86
vsphere-automation-sdk-python/openapi/docs/build/html/vmc/console/vmware.vmc.console.html
anushah 83bd922c86 adding openapi docs
2020-10-12 10:41:34 +05:30

1230 lines
117 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 package &mdash; VMware Automation SDK for Python 0.1.0 documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<!--[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.api package" href="vmware.vmc.console.api.html" />
<link rel="prev" title="vmware.vmc package" href="vmware.vmc.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"><a class="reference internal" href="setup.html">setup module</a></li>
<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>
<li class="toctree-l1"><a class="reference internal" href="../draas/modules.html">draas</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">VMware Automation SDK for Python</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="modules.html">console</a> &raquo;</li>
<li><a href="vmware.html">vmware package</a> &raquo;</li>
<li><a href="vmware.vmc.html">vmware.vmc package</a> &raquo;</li>
<li>vmware.vmc.console package</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/vmc/console/vmware.vmc.console.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-package">
<h1>vmware.vmc.console package<a class="headerlink" href="#vmware-vmc-console-package" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="vmware.vmc.console.api.html">vmware.vmc.console.api package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.account_linking_api">vmware.vmc.console.api.account_linking_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.addons_api">vmware.vmc.console.api.addons_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.clusters_api">vmware.vmc.console.api.clusters_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.config_storage_api">vmware.vmc.console.api.config_storage_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.credentials_api">vmware.vmc.console.api.credentials_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.dns_api">vmware.vmc.console.api.dns_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.edges_api">vmware.vmc.console.api.edges_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.esx_api">vmware.vmc.console.api.esx_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.hcx_api">vmware.vmc.console.api.hcx_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.locale_api">vmware.vmc.console.api.locale_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.msft_licensing_api">vmware.vmc.console.api.msft_licensing_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.network_api">vmware.vmc.console.api.network_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.orgs_api">vmware.vmc.console.api.orgs_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.publicip_api">vmware.vmc.console.api.publicip_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.reservations_api">vmware.vmc.console.api.reservations_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.sddc_api">vmware.vmc.console.api.sddc_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.sddc_networks_api">vmware.vmc.console.api.sddc_networks_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.sddc_template_api">vmware.vmc.console.api.sddc_template_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.storage_api">vmware.vmc.console.api.storage_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.subscription_api">vmware.vmc.console.api.subscription_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.task_api">vmware.vmc.console.api.task_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.tbrs_api">vmware.vmc.console.api.tbrs_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api.troubleshooting_api">vmware.vmc.console.api.troubleshooting_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.api.html#module-vmware.vmc.console.api">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.vmc.console.models.html">vmware.vmc.console.models package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.abstract_entity">vmware.vmc.console.models.abstract_entity module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.account_link_config">vmware.vmc.console.models.account_link_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.account_link_sddc_config">vmware.vmc.console.models.account_link_sddc_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.address_fw_source_destination">vmware.vmc.console.models.address_fw_source_destination module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.agent">vmware.vmc.console.models.agent module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ami_info">vmware.vmc.console.models.ami_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.appliances_summary">vmware.vmc.console.models.appliances_summary module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.application">vmware.vmc.console.models.application module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.available_zone_info">vmware.vmc.console.models.available_zone_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_agent">vmware.vmc.console.models.aws_agent module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_agent_all_of">vmware.vmc.console.models.aws_agent_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_cloud_provider">vmware.vmc.console.models.aws_cloud_provider module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_cloud_provider_all_of">vmware.vmc.console.models.aws_cloud_provider_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_compatible_subnets">vmware.vmc.console.models.aws_compatible_subnets module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_customer_connected_account">vmware.vmc.console.models.aws_customer_connected_account module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_customer_connected_account_all_of">vmware.vmc.console.models.aws_customer_connected_account_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_esx_host">vmware.vmc.console.models.aws_esx_host module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_esx_host_all_of">vmware.vmc.console.models.aws_esx_host_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_key_pair">vmware.vmc.console.models.aws_key_pair module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_kms_info">vmware.vmc.console.models.aws_kms_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_sddc_config">vmware.vmc.console.models.aws_sddc_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_sddc_config_all_of">vmware.vmc.console.models.aws_sddc_config_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_sddc_connection">vmware.vmc.console.models.aws_sddc_connection module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_sddc_connection_all_of">vmware.vmc.console.models.aws_sddc_connection_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_sddc_resource_config">vmware.vmc.console.models.aws_sddc_resource_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_sddc_resource_config_all_of">vmware.vmc.console.models.aws_sddc_resource_config_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.aws_subnet">vmware.vmc.console.models.aws_subnet module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ca_certificates">vmware.vmc.console.models.ca_certificates module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.cbm_statistic">vmware.vmc.console.models.cbm_statistic module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.cbm_statistics">vmware.vmc.console.models.cbm_statistics module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.cbm_stats_data">vmware.vmc.console.models.cbm_stats_data module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.cloud_provider">vmware.vmc.console.models.cloud_provider module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.cluster">vmware.vmc.console.models.cluster module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.cluster_config">vmware.vmc.console.models.cluster_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.cluster_reconfigure_params">vmware.vmc.console.models.cluster_reconfigure_params module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.compute_gateway_template">vmware.vmc.console.models.compute_gateway_template module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.compute_gateway_template_all_of">vmware.vmc.console.models.compute_gateway_template_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.config_spec">vmware.vmc.console.models.config_spec module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.connectivity_agent_validation">vmware.vmc.console.models.connectivity_agent_validation module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.connectivity_validation_group">vmware.vmc.console.models.connectivity_validation_group module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.connectivity_validation_groups">vmware.vmc.console.models.connectivity_validation_groups module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.connectivity_validation_input">vmware.vmc.console.models.connectivity_validation_input module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.connectivity_validation_sub_group">vmware.vmc.console.models.connectivity_validation_sub_group module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.crl_certificates">vmware.vmc.console.models.crl_certificates module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.customer_eni_info">vmware.vmc.console.models.customer_eni_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dashboard_data">vmware.vmc.console.models.dashboard_data module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dashboard_stat">vmware.vmc.console.models.dashboard_stat module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dashboard_statistics">vmware.vmc.console.models.dashboard_statistics module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.data_page_edge_summary">vmware.vmc.console.models.data_page_edge_summary module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.data_page_sddc_network">vmware.vmc.console.models.data_page_sddc_network module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.data_permissions">vmware.vmc.console.models.data_permissions module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dhcp_lease_info">vmware.vmc.console.models.dhcp_lease_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dhcp_leases">vmware.vmc.console.models.dhcp_leases module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dns_config">vmware.vmc.console.models.dns_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dns_forwarders">vmware.vmc.console.models.dns_forwarders module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dns_listeners">vmware.vmc.console.models.dns_listeners module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dns_listeners_all_of">vmware.vmc.console.models.dns_listeners_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dns_response_stats">vmware.vmc.console.models.dns_response_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dns_status_and_stats">vmware.vmc.console.models.dns_status_and_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dns_view">vmware.vmc.console.models.dns_view module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dns_view_match">vmware.vmc.console.models.dns_view_match module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.dns_views">vmware.vmc.console.models.dns_views module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ebs_backed_vsan_config">vmware.vmc.console.models.ebs_backed_vsan_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.edge_job">vmware.vmc.console.models.edge_job module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.edge_status">vmware.vmc.console.models.edge_status module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.edge_summary">vmware.vmc.console.models.edge_summary module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.edge_vm_status">vmware.vmc.console.models.edge_vm_status module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.edge_vnic_address_group">vmware.vmc.console.models.edge_vnic_address_group module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.edge_vnic_address_groups">vmware.vmc.console.models.edge_vnic_address_groups module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.eni_info">vmware.vmc.console.models.eni_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.entity_capacity">vmware.vmc.console.models.entity_capacity module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.error_response">vmware.vmc.console.models.error_response module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.esx_config">vmware.vmc.console.models.esx_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.esx_host">vmware.vmc.console.models.esx_host module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.esx_host_info">vmware.vmc.console.models.esx_host_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.extended_attribute">vmware.vmc.console.models.extended_attribute module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.feature_capabilities">vmware.vmc.console.models.feature_capabilities module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.feature_capability">vmware.vmc.console.models.feature_capability module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.feature_status">vmware.vmc.console.models.feature_status module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.firewall_config">vmware.vmc.console.models.firewall_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.firewall_dashboard_stats">vmware.vmc.console.models.firewall_dashboard_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.firewall_default_policy">vmware.vmc.console.models.firewall_default_policy module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.firewall_global_config">vmware.vmc.console.models.firewall_global_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.firewall_rule">vmware.vmc.console.models.firewall_rule module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.firewall_rule_scope">vmware.vmc.console.models.firewall_rule_scope module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.firewall_rule_stats">vmware.vmc.console.models.firewall_rule_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.firewall_rules">vmware.vmc.console.models.firewall_rules module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.firewall_service">vmware.vmc.console.models.firewall_service module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.gateway_template">vmware.vmc.console.models.gateway_template module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.glcm_bundle">vmware.vmc.console.models.glcm_bundle module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.host_instance_types">vmware.vmc.console.models.host_instance_types module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.host_lease_info">vmware.vmc.console.models.host_lease_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.instance_type_config">vmware.vmc.console.models.instance_type_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.interaction_permissions">vmware.vmc.console.models.interaction_permissions module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.interfaces_dashboard_stats">vmware.vmc.console.models.interfaces_dashboard_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ip_addresses">vmware.vmc.console.models.ip_addresses module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ipsec">vmware.vmc.console.models.ipsec module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ipsec_dashboard_stats">vmware.vmc.console.models.ipsec_dashboard_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ipsec_global_config">vmware.vmc.console.models.ipsec_global_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ipsec_site">vmware.vmc.console.models.ipsec_site module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ipsec_site_ike_status">vmware.vmc.console.models.ipsec_site_ike_status module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ipsec_site_stats">vmware.vmc.console.models.ipsec_site_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ipsec_sites">vmware.vmc.console.models.ipsec_sites module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ipsec_status_and_stats">vmware.vmc.console.models.ipsec_status_and_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.ipsec_tunnel_stats">vmware.vmc.console.models.ipsec_tunnel_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.key_value_attributes">vmware.vmc.console.models.key_value_attributes module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.kms_vpc_endpoint">vmware.vmc.console.models.kms_vpc_endpoint module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.l2_extension">vmware.vmc.console.models.l2_extension module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.l2_vpn">vmware.vmc.console.models.l2_vpn module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.l2vpn_stats">vmware.vmc.console.models.l2vpn_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.l2vpn_status_and_stats">vmware.vmc.console.models.l2vpn_status_and_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.licence_acl_permissions">vmware.vmc.console.models.licence_acl_permissions module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.load_balancer_dashboard_stats">vmware.vmc.console.models.load_balancer_dashboard_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.logging">vmware.vmc.console.models.logging module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.logical_network">vmware.vmc.console.models.logical_network module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.logical_router_scope">vmware.vmc.console.models.logical_router_scope module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.logical_router_scopes">vmware.vmc.console.models.logical_router_scopes module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.mac_address">vmware.vmc.console.models.mac_address module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.maintenance_window">vmware.vmc.console.models.maintenance_window module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.maintenance_window_entry">vmware.vmc.console.models.maintenance_window_entry module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.maintenance_window_get">vmware.vmc.console.models.maintenance_window_get module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.maintenance_window_get_all_of">vmware.vmc.console.models.maintenance_window_get_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.management_gateway_template">vmware.vmc.console.models.management_gateway_template module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.management_gateway_template_all_of">vmware.vmc.console.models.management_gateway_template_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.map_zones_request">vmware.vmc.console.models.map_zones_request module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.meta_dashboard_stats">vmware.vmc.console.models.meta_dashboard_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.metadata">vmware.vmc.console.models.metadata module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.msft_licensing_config">vmware.vmc.console.models.msft_licensing_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.nat">vmware.vmc.console.models.nat module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.nat_rule">vmware.vmc.console.models.nat_rule module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.nat_rules">vmware.vmc.console.models.nat_rules module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.network_template">vmware.vmc.console.models.network_template module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.new_credentials">vmware.vmc.console.models.new_credentials module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.nsxfirewallrule">vmware.vmc.console.models.nsxfirewallrule module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.nsxfirewallservice">vmware.vmc.console.models.nsxfirewallservice module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.nsxl2vpn">vmware.vmc.console.models.nsxl2vpn module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.nsxnatrule">vmware.vmc.console.models.nsxnatrule module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.nsxsite">vmware.vmc.console.models.nsxsite module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.nsxt_addons">vmware.vmc.console.models.nsxt_addons module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.object_type">vmware.vmc.console.models.object_type module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.offer_instances_holder">vmware.vmc.console.models.offer_instances_holder module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.offer_type">vmware.vmc.console.models.offer_type module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.on_demand_offer_instance">vmware.vmc.console.models.on_demand_offer_instance module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.org_properties">vmware.vmc.console.models.org_properties module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.org_seller_info">vmware.vmc.console.models.org_seller_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.organization">vmware.vmc.console.models.organization module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.organization_all_of">vmware.vmc.console.models.organization_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.paged_edge_list">vmware.vmc.console.models.paged_edge_list module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.paging_info">vmware.vmc.console.models.paging_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.payment_method_info">vmware.vmc.console.models.payment_method_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.pop_agent_xeni_connection">vmware.vmc.console.models.pop_agent_xeni_connection module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.pop_ami_info">vmware.vmc.console.models.pop_ami_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.pop_ami_info_all_of">vmware.vmc.console.models.pop_ami_info_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.pop_info">vmware.vmc.console.models.pop_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.pop_service_info">vmware.vmc.console.models.pop_service_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.provision_spec">vmware.vmc.console.models.provision_spec module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.requests">vmware.vmc.console.models.requests module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.reservation">vmware.vmc.console.models.reservation module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.reservation_in_mw">vmware.vmc.console.models.reservation_in_mw module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.reservation_schedule">vmware.vmc.console.models.reservation_schedule module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.reservation_schedule_all_of">vmware.vmc.console.models.reservation_schedule_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.reservation_window">vmware.vmc.console.models.reservation_window module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.reservation_window_maintenance_properties">vmware.vmc.console.models.reservation_window_maintenance_properties module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.result">vmware.vmc.console.models.result module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.route_table_info">vmware.vmc.console.models.route_table_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.scope_info">vmware.vmc.console.models.scope_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc">vmware.vmc.console.models.sddc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_all_of">vmware.vmc.console.models.sddc_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_allocate_public_ip_spec">vmware.vmc.console.models.sddc_allocate_public_ip_spec module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_config">vmware.vmc.console.models.sddc_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_config_spec">vmware.vmc.console.models.sddc_config_spec module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_id">vmware.vmc.console.models.sddc_id module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_link_config">vmware.vmc.console.models.sddc_link_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_manifest">vmware.vmc.console.models.sddc_manifest module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_network">vmware.vmc.console.models.sddc_network module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_network_address_group">vmware.vmc.console.models.sddc_network_address_group module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_network_address_groups">vmware.vmc.console.models.sddc_network_address_groups module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_network_dhcp_config">vmware.vmc.console.models.sddc_network_dhcp_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_network_dhcp_ip_pool">vmware.vmc.console.models.sddc_network_dhcp_ip_pool module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_patch_request">vmware.vmc.console.models.sddc_patch_request module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_public_ip">vmware.vmc.console.models.sddc_public_ip module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_resource_config">vmware.vmc.console.models.sddc_resource_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_size">vmware.vmc.console.models.sddc_size module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_state_request">vmware.vmc.console.models.sddc_state_request module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_template">vmware.vmc.console.models.sddc_template module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sddc_template_all_of">vmware.vmc.console.models.sddc_template_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.secondary_addresses">vmware.vmc.console.models.secondary_addresses module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.service_error">vmware.vmc.console.models.service_error module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.site">vmware.vmc.console.models.site module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sites">vmware.vmc.console.models.sites module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sslvpn_dashboard_stats">vmware.vmc.console.models.sslvpn_dashboard_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sub_interface">vmware.vmc.console.models.sub_interface module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.sub_interfaces">vmware.vmc.console.models.sub_interfaces module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.subnet">vmware.vmc.console.models.subnet module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.subnet_info">vmware.vmc.console.models.subnet_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.subnet_info_all_of">vmware.vmc.console.models.subnet_info_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.subnet_route_table_info">vmware.vmc.console.models.subnet_route_table_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.subnets">vmware.vmc.console.models.subnets module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.subscription_details">vmware.vmc.console.models.subscription_details module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.subscription_products">vmware.vmc.console.models.subscription_products module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.subscription_request">vmware.vmc.console.models.subscription_request module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.support_window">vmware.vmc.console.models.support_window module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.support_window_id">vmware.vmc.console.models.support_window_id module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.task">vmware.vmc.console.models.task module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.task_all_of">vmware.vmc.console.models.task_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.task_progress_phase">vmware.vmc.console.models.task_progress_phase module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.term_billing_options">vmware.vmc.console.models.term_billing_options module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.term_offer_instance">vmware.vmc.console.models.term_offer_instance module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.traffic_shaping_policy">vmware.vmc.console.models.traffic_shaping_policy module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.update_credentials">vmware.vmc.console.models.update_credentials module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vmc_locale">vmware.vmc.console.models.vmc_locale module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vnic">vmware.vmc.console.models.vnic module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vnics">vmware.vmc.console.models.vnics module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vpc_info">vmware.vmc.console.models.vpc_info module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vpc_info_subnets">vmware.vmc.console.models.vpc_info_subnets module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vpc_info_subnets_all_of">vmware.vmc.console.models.vpc_info_subnets_all_of module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vpn">vmware.vmc.console.models.vpn module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vpn_channel_status">vmware.vmc.console.models.vpn_channel_status module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vpn_tunnel_status">vmware.vmc.console.models.vpn_tunnel_status module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vpn_tunnel_traffic_stats">vmware.vmc.console.models.vpn_tunnel_traffic_stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vsan_available_capacity">vmware.vmc.console.models.vsan_available_capacity module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vsan_cluster_reconfig_bias">vmware.vmc.console.models.vsan_cluster_reconfig_bias module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vsan_cluster_reconfig_constraints">vmware.vmc.console.models.vsan_cluster_reconfig_constraints module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vsan_config_constraints">vmware.vmc.console.models.vsan_config_constraints module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models.vsan_encryption_config">vmware.vmc.console.models.vsan_encryption_config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vmc.console.models.html#module-vmware.vmc.console.models">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-vmware.vmc.console.api_client">
<span id="vmware-vmc-console-api-client-module"></span><h2>vmware.vmc.console.api_client module<a class="headerlink" href="#module-vmware.vmc.console.api_client" title="Permalink to this headline"></a></h2>
<p>VMware Cloud APIs</p>
<ul class="simple">
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>&#160;&#160; <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-H</span> <span class="pre">&quot;Content-Type:</span> <span class="pre">application/json&quot;</span> <span class="pre">\</span>&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token}</span>&#160;&#160; <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
</ul>
<p>The version of the OpenAPI document: 1.0
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_client.ApiClient">
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.api_client.</code><code class="sig-name descname">ApiClient</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">configuration</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">header_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">header_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cookie</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">pool_threads</span><span class="o">=</span><span class="default_value">1</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient" 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>Generic API client for OpenAPI client library builds.</p>
<p>OpenAPI generic API client. This client handles the client-
server communication, and is invariant across implementations. Specifics of
the methods and models for each application are generated from the OpenAPI
templates.</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>
Do not edit the class manually.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>configuration</strong> – .Configuration object for this client</p></li>
<li><p><strong>header_name</strong> – a header to pass when making calls to the API.</p></li>
<li><p><strong>header_value</strong> – a header value to pass when making calls to
the API.</p></li>
<li><p><strong>cookie</strong> – a cookie to include in the header when making calls
to the API</p></li>
<li><p><strong>pool_threads</strong> – The number of threads to use for async requests
to the API. More threads means more concurrent API requests.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.api_client.ApiClient.NATIVE_TYPES_MAPPING">
<code class="sig-name descname">NATIVE_TYPES_MAPPING</code><em class="property"> = {'bool': &lt;class 'bool'&gt;, 'date': &lt;class 'datetime.date'&gt;, 'datetime': &lt;class 'datetime.datetime'&gt;, 'float': &lt;class 'float'&gt;, 'int': &lt;class 'int'&gt;, 'long': &lt;class 'int'&gt;, 'object': &lt;class 'object'&gt;, 'str': &lt;class 'str'&gt;}</em><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient.NATIVE_TYPES_MAPPING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.api_client.ApiClient.PRIMITIVE_TYPES">
<code class="sig-name descname">PRIMITIVE_TYPES</code><em class="property"> = (&lt;class 'float'&gt;, &lt;class 'bool'&gt;, &lt;class 'bytes'&gt;, &lt;class 'str'&gt;, &lt;class 'int'&gt;)</em><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient.PRIMITIVE_TYPES" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.call_api">
<code class="sig-name descname">call_api</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">resource_path</span></em>, <em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">path_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">query_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">header_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">body</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">post_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">files</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">response_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">auth_settings</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">async_req</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">_return_http_data_only</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">collection_formats</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">_preload_content</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">_request_timeout</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">_host</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_client.ApiClient.call_api" title="Permalink to this definition"></a></dt>
<dd><p>Makes the HTTP request (synchronous) and returns deserialized data.</p>
<p>To make an async_req request, set the async_req parameter.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>resource_path</strong> – Path to method endpoint.</p></li>
<li><p><strong>method</strong> – Method to call.</p></li>
<li><p><strong>path_params</strong> – Path parameters in the url.</p></li>
<li><p><strong>query_params</strong> – Query parameters in the url.</p></li>
<li><p><strong>header_params</strong> – Header parameters to be
placed in the request header.</p></li>
<li><p><strong>body</strong> – Request body.</p></li>
<li><p><strong>dict</strong> (<em>files</em>) – Request post form parameters,
for <cite>application/x-www-form-urlencoded</cite>, <cite>multipart/form-data</cite>.</p></li>
<li><p><strong>list</strong> (<em>auth_settings</em>) – Auth Settings names for the request.</p></li>
<li><p><strong>response</strong> – Response data type.</p></li>
<li><p><strong>dict</strong> – key -&gt; filename, value -&gt; filepath,
for <cite>multipart/form-data</cite>.</p></li>
<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>collection_formats</strong> – dict of collection formats for path, query,
header, and post parameters.</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>If async_req parameter is True,
the request will be called asynchronously.
The method will return the request thread.
If parameter async_req is False or missing,
then the method will return the response directly.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.close">
<code class="sig-name descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient.close" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.deserialize">
<code class="sig-name descname">deserialize</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">response</span></em>, <em class="sig-param"><span class="n">response_type</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient.deserialize" title="Permalink to this definition"></a></dt>
<dd><p>Deserializes response into an object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>response</strong> – RESTResponse object to be deserialized.</p></li>
<li><p><strong>response_type</strong> – class literal for
deserialized object, or string of class name.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>deserialized object.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.files_parameters">
<code class="sig-name descname">files_parameters</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">files</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_client.ApiClient.files_parameters" title="Permalink to this definition"></a></dt>
<dd><p>Builds form parameters.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>files</strong> – File parameters.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Form parameters with files.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.parameters_to_tuples">
<code class="sig-name descname">parameters_to_tuples</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">params</span></em>, <em class="sig-param"><span class="n">collection_formats</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient.parameters_to_tuples" title="Permalink to this definition"></a></dt>
<dd><p>Get parameters as list of tuples, formatting collections.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>params</strong> – Parameters as dict or list of two-tuples</p></li>
<li><p><strong>collection_formats</strong> (<em>dict</em>) – Parameter collection formats</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Parameters as list of tuples, collections formatted</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.pool">
<em class="property">property </em><code class="sig-name descname">pool</code><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient.pool" title="Permalink to this definition"></a></dt>
<dd><p>Create thread pool on first request
avoids instantiating unused threadpool for blocking clients.</p>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.request">
<code class="sig-name descname">request</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">query_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">headers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">post_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">body</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">_preload_content</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">_request_timeout</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_client.ApiClient.request" title="Permalink to this definition"></a></dt>
<dd><p>Makes the HTTP request using RESTClient.</p>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.sanitize_for_serialization">
<code class="sig-name descname">sanitize_for_serialization</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient.sanitize_for_serialization" title="Permalink to this definition"></a></dt>
<dd><p>Builds a JSON POST object.</p>
<p>If obj is None, return None.
If obj is str, int, long, float, bool, return directly.
If obj is datetime.datetime, datetime.date</p>
<blockquote>
<div><p>convert to string in iso8601 format.</p>
</div></blockquote>
<p>If obj is list, sanitize each element in the list.
If obj is dict, return the dict.
If obj is OpenAPI model, return the properties dict.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>obj</strong> – The data to serialize.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The serialized form of data.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.select_header_accept">
<code class="sig-name descname">select_header_accept</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">accepts</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient.select_header_accept" title="Permalink to this definition"></a></dt>
<dd><p>Returns <cite>Accept</cite> based on an array of accepts provided.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>accepts</strong> – List of headers.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Accept (e.g. application/json).</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.select_header_content_type">
<code class="sig-name descname">select_header_content_type</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">content_types</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient.select_header_content_type" title="Permalink to this definition"></a></dt>
<dd><p>Returns <cite>Content-Type</cite> based on an array of content_types provided.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>content_types</strong> – List of content-types.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Content-Type (e.g. application/json).</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.set_default_header">
<code class="sig-name descname">set_default_header</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">header_name</span></em>, <em class="sig-param"><span class="n">header_value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient.set_default_header" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.update_params_for_auth">
<code class="sig-name descname">update_params_for_auth</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">headers</span></em>, <em class="sig-param"><span class="n">querys</span></em>, <em class="sig-param"><span class="n">auth_settings</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient.update_params_for_auth" title="Permalink to this definition"></a></dt>
<dd><p>Updates header and query params based on authentication setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>headers</strong> – Header parameters dict to be updated.</p></li>
<li><p><strong>querys</strong> – Query parameters tuple list to be updated.</p></li>
<li><p><strong>auth_settings</strong> – Authentication setting identifiers list.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.api_client.ApiClient.user_agent">
<em class="property">property </em><code class="sig-name descname">user_agent</code><a class="headerlink" href="#vmware.vmc.console.api_client.ApiClient.user_agent" title="Permalink to this definition"></a></dt>
<dd><p>User agent for this API client</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-vmware.vmc.console.configuration">
<span id="vmware-vmc-console-configuration-module"></span><h2>vmware.vmc.console.configuration module<a class="headerlink" href="#module-vmware.vmc.console.configuration" title="Permalink to this headline"></a></h2>
<p>VMware Cloud APIs</p>
<ul class="simple">
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>&#160;&#160; <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-H</span> <span class="pre">&quot;Content-Type:</span> <span class="pre">application/json&quot;</span> <span class="pre">\</span>&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token}</span>&#160;&#160; <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
</ul>
<p>The version of the OpenAPI document: 1.0
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.configuration.Configuration">
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.configuration.</code><code class="sig-name descname">Configuration</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">'https://vmc.vmware.com/vmc/api'</span></em>, <em class="sig-param"><span class="n">api_key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">api_key_prefix</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">username</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">discard_unknown_keys</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration" 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</p>
<blockquote>
<div><p>Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a>
Do not edit the class manually.</p>
<dl class="field-list">
<dt class="field-odd">param host</dt>
<dd class="field-odd"><p>Base url</p>
</dd>
<dt class="field-even">param api_key</dt>
<dd class="field-even"><p>Dict to store API key(s).
Each entry in the dict specifies an API key.
The dict key is the name of the security scheme in the OAS specification.
The dict value is the API key secret.</p>
</dd>
<dt class="field-odd">param api_key_prefix</dt>
<dd class="field-odd"><p>Dict to store API prefix (e.g. Bearer)
The dict key is the name of the security scheme in the OAS specification.
The dict value is an API key prefix when generating the auth data.</p>
</dd>
<dt class="field-even">param username</dt>
<dd class="field-even"><p>Username for HTTP basic authentication</p>
</dd>
<dt class="field-odd">param password</dt>
<dd class="field-odd"><p>Password for HTTP basic authentication</p>
</dd>
<dt class="field-even">param discard_unknown_keys</dt>
<dd class="field-even"><p>Boolean value indicating whether to discard
unknown properties. A server may send a response that includes additional
properties that are not known by the client in the following scenarios:
1. The OpenAPI document is incomplete, i.e. it does not match the server</p>
<blockquote>
<div><p>implementation.</p>
</div></blockquote>
<ol class="arabic simple" start="2">
<li><p>The client was generated using an older version of the OpenAPI document
and the server has been upgraded since then.</p></li>
</ol>
<p>If a schema in the OpenAPI document defines the additionalProperties attribute,
then all undeclared properties received by the server are injected into the
additional properties map. In that case, there are undeclared properties, and
nothing to discard.</p>
</dd>
<dt class="field-odd">Example</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>API Key Authentication Example.
Given the following security scheme in the OpenAPI specification:</p>
<blockquote>
<div><dl class="simple">
<dt>components:</dt><dd><dl class="simple">
<dt>securitySchemes:</dt><dd><dl class="simple">
<dt>cookieAuth: # name for the security scheme</dt><dd><p>type: apiKey
in: cookie
name: JSESSIONID # cookie name</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
<p>You can programmatically set the cookie:</p>
</div></blockquote>
<dl class="simple">
<dt>conf = vmware.vmc.console.Configuration(</dt><dd><p>api_key={‘cookieAuth’: ‘abc123’}
api_key_prefix={‘cookieAuth’: ‘JSESSIONID’}</p>
</dd>
</dl>
<p>)</p>
<blockquote>
<div><dl class="simple">
<dt>The following cookie will be added to the HTTP request:</dt><dd><p>Cookie: JSESSIONID abc123</p>
</dd>
</dl>
</div></blockquote>
<p>Constructor</p>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.assert_hostname">
<code class="sig-name descname">assert_hostname</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.assert_hostname" title="Permalink to this definition"></a></dt>
<dd><p>Set this to True/False to enable/disable SSL hostname verification.</p>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.configuration.Configuration.auth_settings">
<code class="sig-name descname">auth_settings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.auth_settings" title="Permalink to this definition"></a></dt>
<dd><p>Gets Auth Settings dict for api client.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The Auth Settings information dict.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.cert_file">
<code class="sig-name descname">cert_file</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.cert_file" title="Permalink to this definition"></a></dt>
<dd><p>client certificate file</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.connection_pool_maxsize">
<code class="sig-name descname">connection_pool_maxsize</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.connection_pool_maxsize" title="Permalink to this definition"></a></dt>
<dd><p>urllib3 connection pool’s maximum number of connections saved
per pool. urllib3 uses 1 connection as default value, but this is
not the best value when you are making a lot of possibly parallel
requests to the same host, which is often the case here.
cpu_count * 5 is used as default value to increase performance.</p>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.configuration.Configuration.debug">
<em class="property">property </em><code class="sig-name descname">debug</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.debug" title="Permalink to this definition"></a></dt>
<dd><p>Debug switch</p>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.configuration.Configuration.get_api_key_with_prefix">
<code class="sig-name descname">get_api_key_with_prefix</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">identifier</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.get_api_key_with_prefix" title="Permalink to this definition"></a></dt>
<dd><p>Gets API key (with prefix if set).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>identifier</strong> – The identifier of apiKey.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The token for api key authentication.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.configuration.Configuration.get_basic_auth_token">
<code class="sig-name descname">get_basic_auth_token</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.get_basic_auth_token" title="Permalink to this definition"></a></dt>
<dd><p>Gets HTTP basic authentication header (string).</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The token for basic HTTP authentication.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.configuration.Configuration.get_default_copy">
<em class="property">classmethod </em><code class="sig-name descname">get_default_copy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.get_default_copy" title="Permalink to this definition"></a></dt>
<dd><p>Return new instance of configuration.</p>
<p>This method returns newly created, based on default constructor,
object of Configuration class or returns a copy of default
configuration passed by the set_default method.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The configuration object.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.configuration.Configuration.get_host_from_settings">
<code class="sig-name descname">get_host_from_settings</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">index</span></em>, <em class="sig-param"><span class="n">variables</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.get_host_from_settings" title="Permalink to this definition"></a></dt>
<dd><p>Gets host URL based on the index and variables
:param index: array index of the host settings
:param variables: hash of variable and the corresponding value
:return: URL based on host settings</p>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.configuration.Configuration.get_host_settings">
<code class="sig-name descname">get_host_settings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.get_host_settings" title="Permalink to this definition"></a></dt>
<dd><p>Gets an array of host settings</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>An array of host settings</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.host">
<code class="sig-name descname">host</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.host" title="Permalink to this definition"></a></dt>
<dd><p>Default Base url</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.key_file">
<code class="sig-name descname">key_file</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.key_file" title="Permalink to this definition"></a></dt>
<dd><p>client key file</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.logger">
<code class="sig-name descname">logger</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.logger" title="Permalink to this definition"></a></dt>
<dd><p>Logging Settings</p>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.configuration.Configuration.logger_file">
<em class="property">property </em><code class="sig-name descname">logger_file</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.logger_file" title="Permalink to this definition"></a></dt>
<dd><p>Debug file location</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.logger_file_handler">
<code class="sig-name descname">logger_file_handler</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.logger_file_handler" title="Permalink to this definition"></a></dt>
<dd><p>Log file handler</p>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.configuration.Configuration.logger_format">
<em class="property">property </em><code class="sig-name descname">logger_format</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.logger_format" title="Permalink to this definition"></a></dt>
<dd><p>Log format</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.logger_stream_handler">
<code class="sig-name descname">logger_stream_handler</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.logger_stream_handler" title="Permalink to this definition"></a></dt>
<dd><p>Log stream handler</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.password">
<code class="sig-name descname">password</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.password" title="Permalink to this definition"></a></dt>
<dd><p>Password for HTTP basic authentication</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.proxy">
<code class="sig-name descname">proxy</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.proxy" title="Permalink to this definition"></a></dt>
<dd><p>Proxy URL</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.proxy_headers">
<code class="sig-name descname">proxy_headers</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.proxy_headers" title="Permalink to this definition"></a></dt>
<dd><p>Proxy headers</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.refresh_api_key_hook">
<code class="sig-name descname">refresh_api_key_hook</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.refresh_api_key_hook" title="Permalink to this definition"></a></dt>
<dd><p>function hook to refresh API key if expired</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.retries">
<code class="sig-name descname">retries</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.retries" title="Permalink to this definition"></a></dt>
<dd><p>Adding retries to override urllib3 default value 3</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.safe_chars_for_path_param">
<code class="sig-name descname">safe_chars_for_path_param</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.safe_chars_for_path_param" title="Permalink to this definition"></a></dt>
<dd><p>Safe chars for path_param</p>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.configuration.Configuration.set_default">
<em class="property">classmethod </em><code class="sig-name descname">set_default</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">default</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.set_default" title="Permalink to this definition"></a></dt>
<dd><p>Set default instance of configuration.</p>
<p>It stores default configuration, which can be
returned by get_default_copy method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>default</strong> – object of Configuration</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.ssl_ca_cert">
<code class="sig-name descname">ssl_ca_cert</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.ssl_ca_cert" title="Permalink to this definition"></a></dt>
<dd><p>Set this to customize the certificate file to verify the peer.</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.temp_folder_path">
<code class="sig-name descname">temp_folder_path</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.temp_folder_path" title="Permalink to this definition"></a></dt>
<dd><p>Temp file folder for downloading files</p>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.configuration.Configuration.to_debug_report">
<code class="sig-name descname">to_debug_report</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.to_debug_report" title="Permalink to this definition"></a></dt>
<dd><p>Gets the essential information for debugging.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The report for debugging.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.username">
<code class="sig-name descname">username</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.username" title="Permalink to this definition"></a></dt>
<dd><p>Username for HTTP basic authentication</p>
</dd></dl>
<dl class="py attribute">
<dt id="vmware.vmc.console.configuration.Configuration.verify_ssl">
<code class="sig-name descname">verify_ssl</code><a class="headerlink" href="#vmware.vmc.console.configuration.Configuration.verify_ssl" title="Permalink to this definition"></a></dt>
<dd><p>SSL/TLS verification
Set this to false to skip verifying SSL certificate when calling API
from https server.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-vmware.vmc.console.exceptions">
<span id="vmware-vmc-console-exceptions-module"></span><h2>vmware.vmc.console.exceptions module<a class="headerlink" href="#module-vmware.vmc.console.exceptions" title="Permalink to this headline"></a></h2>
<p>VMware Cloud APIs</p>
<ul class="simple">
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>&#160;&#160; <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-H</span> <span class="pre">&quot;Content-Type:</span> <span class="pre">application/json&quot;</span> <span class="pre">\</span>&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token}</span>&#160;&#160; <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
</ul>
<p>The version of the OpenAPI document: 1.0
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
<dl class="py exception">
<dt id="vmware.vmc.console.exceptions.ApiException">
<em class="property">exception </em><code class="sig-prename descclassname">vmware.vmc.console.exceptions.</code><code class="sig-name descname">ApiException</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">reason</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">http_resp</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.exceptions.ApiException" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#vmware.vmc.console.exceptions.OpenApiException" title="vmware.vmc.console.exceptions.OpenApiException"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vmc.console.exceptions.OpenApiException</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt id="vmware.vmc.console.exceptions.ApiKeyError">
<em class="property">exception </em><code class="sig-prename descclassname">vmware.vmc.console.exceptions.</code><code class="sig-name descname">ApiKeyError</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">msg</span></em>, <em class="sig-param"><span class="n">path_to_item</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.exceptions.ApiKeyError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#vmware.vmc.console.exceptions.OpenApiException" title="vmware.vmc.console.exceptions.OpenApiException"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vmc.console.exceptions.OpenApiException</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">KeyError</span></code></p>
<dl class="simple">
<dt>Args:</dt><dd><p>msg (str): the exception message</p>
</dd>
<dt>Keyword Args:</dt><dd><dl class="simple">
<dt>path_to_item (None/list) the path to the exception in the</dt><dd><p>received_data dict</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt id="vmware.vmc.console.exceptions.ApiTypeError">
<em class="property">exception </em><code class="sig-prename descclassname">vmware.vmc.console.exceptions.</code><code class="sig-name descname">ApiTypeError</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">msg</span></em>, <em class="sig-param"><span class="n">path_to_item</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">valid_classes</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key_type</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.exceptions.ApiTypeError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#vmware.vmc.console.exceptions.OpenApiException" title="vmware.vmc.console.exceptions.OpenApiException"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vmc.console.exceptions.OpenApiException</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">TypeError</span></code></p>
<p>Raises an exception for TypeErrors</p>
<dl class="simple">
<dt>Args:</dt><dd><p>msg (str): the exception message</p>
</dd>
<dt>Keyword Args:</dt><dd><dl class="simple">
<dt>path_to_item (list): a list of keys an indices to get to the</dt><dd><p>current_item
None if unset</p>
</dd>
<dt>valid_classes (tuple): the primitive classes that current item</dt><dd><p>should be an instance of
None if unset</p>
</dd>
<dt>key_type (bool): False if our value is a value in a dict</dt><dd><p>True if it is a key in a dict
False if our item is an item in a list
None if unset</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt id="vmware.vmc.console.exceptions.ApiValueError">
<em class="property">exception </em><code class="sig-prename descclassname">vmware.vmc.console.exceptions.</code><code class="sig-name descname">ApiValueError</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">msg</span></em>, <em class="sig-param"><span class="n">path_to_item</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.exceptions.ApiValueError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#vmware.vmc.console.exceptions.OpenApiException" title="vmware.vmc.console.exceptions.OpenApiException"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vmc.console.exceptions.OpenApiException</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></p>
<dl class="simple">
<dt>Args:</dt><dd><p>msg (str): the exception message</p>
</dd>
<dt>Keyword Args:</dt><dd><dl class="simple">
<dt>path_to_item (list) the path to the exception in the</dt><dd><p>received_data dict. None if unset</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt id="vmware.vmc.console.exceptions.OpenApiException">
<em class="property">exception </em><code class="sig-prename descclassname">vmware.vmc.console.exceptions.</code><code class="sig-name descname">OpenApiException</code><a class="headerlink" href="#vmware.vmc.console.exceptions.OpenApiException" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>The base exception class for all OpenAPIExceptions</p>
</dd></dl>
<dl class="py function">
<dt id="vmware.vmc.console.exceptions.render_path">
<code class="sig-prename descclassname">vmware.vmc.console.exceptions.</code><code class="sig-name descname">render_path</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path_to_item</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.exceptions.render_path" title="Permalink to this definition"></a></dt>
<dd><p>Returns a string representation of a path</p>
</dd></dl>
</div>
<div class="section" id="module-vmware.vmc.console.rest">
<span id="vmware-vmc-console-rest-module"></span><h2>vmware.vmc.console.rest module<a class="headerlink" href="#module-vmware.vmc.console.rest" title="Permalink to this headline"></a></h2>
<p>VMware Cloud APIs</p>
<ul class="simple">
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>&#160;&#160; <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-H</span> <span class="pre">&quot;Content-Type:</span> <span class="pre">application/json&quot;</span> <span class="pre">\</span>&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token}</span>&#160;&#160; <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
</ul>
<p>The version of the OpenAPI document: 1.0
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.rest.RESTClientObject">
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.rest.</code><code class="sig-name descname">RESTClientObject</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">configuration</span></em>, <em class="sig-param"><span class="n">pools_size</span><span class="o">=</span><span class="default_value">4</span></em>, <em class="sig-param"><span class="n">maxsize</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.rest.RESTClientObject" 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>
<dl class="py method">
<dt id="vmware.vmc.console.rest.RESTClientObject.DELETE">
<code class="sig-name descname">DELETE</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">headers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">query_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">body</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">_preload_content</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">_request_timeout</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.rest.RESTClientObject.DELETE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.rest.RESTClientObject.GET">
<code class="sig-name descname">GET</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">headers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">query_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">_preload_content</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">_request_timeout</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.rest.RESTClientObject.GET" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.rest.RESTClientObject.HEAD">
<code class="sig-name descname">HEAD</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">headers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">query_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">_preload_content</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">_request_timeout</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.rest.RESTClientObject.HEAD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.rest.RESTClientObject.OPTIONS">
<code class="sig-name descname">OPTIONS</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">headers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">query_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">post_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">body</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">_preload_content</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">_request_timeout</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.rest.RESTClientObject.OPTIONS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.rest.RESTClientObject.PATCH">
<code class="sig-name descname">PATCH</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">headers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">query_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">post_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">body</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">_preload_content</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">_request_timeout</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.rest.RESTClientObject.PATCH" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.rest.RESTClientObject.POST">
<code class="sig-name descname">POST</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">headers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">query_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">post_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">body</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">_preload_content</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">_request_timeout</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.rest.RESTClientObject.POST" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.rest.RESTClientObject.PUT">
<code class="sig-name descname">PUT</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">headers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">query_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">post_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">body</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">_preload_content</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">_request_timeout</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.rest.RESTClientObject.PUT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.rest.RESTClientObject.request">
<code class="sig-name descname">request</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">query_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">headers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">body</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">post_params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">_preload_content</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">_request_timeout</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.rest.RESTClientObject.request" title="Permalink to this definition"></a></dt>
<dd><p>Perform requests.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>method</strong> – http request method</p></li>
<li><p><strong>url</strong> – http request url</p></li>
<li><p><strong>query_params</strong> – query parameters in the url</p></li>
<li><p><strong>headers</strong> – http request headers</p></li>
<li><p><strong>body</strong> – request json body, for <cite>application/json</cite></p></li>
<li><p><strong>post_params</strong> – request post parameters,
<cite>application/x-www-form-urlencoded</cite>
and <cite>multipart/form-data</cite></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>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="vmware.vmc.console.rest.RESTResponse">
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc.console.rest.</code><code class="sig-name descname">RESTResponse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">resp</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.rest.RESTResponse" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">io.IOBase</span></code></p>
<dl class="py method">
<dt id="vmware.vmc.console.rest.RESTResponse.getheader">
<code class="sig-name descname">getheader</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.rest.RESTResponse.getheader" title="Permalink to this definition"></a></dt>
<dd><p>Returns a given response header.</p>
</dd></dl>
<dl class="py method">
<dt id="vmware.vmc.console.rest.RESTResponse.getheaders">
<code class="sig-name descname">getheaders</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc.console.rest.RESTResponse.getheaders" title="Permalink to this definition"></a></dt>
<dd><p>Returns a dictionary of the response headers.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-vmware.vmc.console">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-vmware.vmc.console" title="Permalink to this headline"></a></h2>
<p>VMware Cloud APIs</p>
<ul class="simple">
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>&#160;&#160; <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-H</span> <span class="pre">&quot;Content-Type:</span> <span class="pre">application/json&quot;</span> <span class="pre">\</span>&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token}</span>&#160;&#160; <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
</ul>
<p>The version of the OpenAPI document: 1.0
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="vmware.vmc.console.api.html" class="btn btn-neutral float-right" title="vmware.vmc.console.api package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="vmware.vmc.html" class="btn btn-neutral float-left" title="vmware.vmc package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, VMware Inc.
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink