mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
Updating latest python vmc docs
This commit is contained in:
amanp
parent
9a28a18570
commit
2c914b5728
@ -2,14 +2,13 @@ com package
|
||||
===========
|
||||
|
||||
.. automodule:: com
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware
|
||||
|
||||
com.vmware
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware package
|
||||
==================
|
||||
|
||||
.. automodule:: com.vmware
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vmc
|
||||
com.vmware.vmc
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,8 +20,7 @@ com.vmware.vmc\_client module
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware.vmc.orgs package
|
||||
===========================
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vmc.orgs.sddcs
|
||||
com.vmware.vmc.orgs.sddcs
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,48 +20,42 @@ com.vmware.vmc.orgs.account\_link\_client module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.account_link_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.reservations\_client module
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.reservations_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.sddcs\_client module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.storage\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.storage_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.subscriptions\_client module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.subscriptions_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.tbrs\_client module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.tbrs_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vmc.orgs.sddcs.networks.cgws package
|
||||
===============================================
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.cgws
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn\_client module
|
||||
------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vmc.orgs.sddcs.networks.edges.firewall package
|
||||
=========================================================
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.firewall
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config\_client module
|
||||
-----------------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package
|
||||
======================================================
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config\_client module
|
||||
--------------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vmc.orgs.sddcs.networks.edges.nat package
|
||||
====================================================
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.nat
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.vmc.orgs.sddcs.networks.edges.nat.config\_client module
|
||||
------------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,19 +2,19 @@ com.vmware.vmc.orgs.sddcs.networks.edges package
|
||||
================================================
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.firewall
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.nat
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.statistics
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.firewall
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.nat
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.statistics
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -23,48 +23,42 @@ com.vmware.vmc.orgs.sddcs.networks.edges.dhcp\_client module
|
||||
------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.dns\_client module
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.dns_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.firewall\_client module
|
||||
----------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.ipsec\_client module
|
||||
-------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.nat\_client module
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.nat_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.statistics\_client module
|
||||
------------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vmc.orgs.sddcs.networks.edges.statistics package
|
||||
===========================================================
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.statistics
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,16 +13,14 @@ com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard\_client module
|
||||
----------------------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces\_client module
|
||||
-----------------------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,17 +2,17 @@ com.vmware.vmc.orgs.sddcs.networks package
|
||||
==========================================
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vmc.orgs.sddcs.networks.cgws
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges
|
||||
com.vmware.vmc.orgs.sddcs.networks.cgws
|
||||
com.vmware.vmc.orgs.sddcs.networks.edges
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -21,8 +21,7 @@ com.vmware.vmc.orgs.sddcs.networks.edges\_client module
|
||||
-------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks.edges_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware.vmc.orgs.sddcs package
|
||||
=================================
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vmc.orgs.sddcs.networks
|
||||
com.vmware.vmc.orgs.sddcs.networks
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,40 +20,35 @@ com.vmware.vmc.orgs.sddcs.addons\_client module
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.addons_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.sddcs.dns\_client module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.dns_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.sddcs.management\_vms\_client module
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.management_vms_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.sddcs.networking\_client module
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networking_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs.sddcs.networks\_client module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.networks_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware.vmc package
|
||||
======================
|
||||
|
||||
.. automodule:: com.vmware.vmc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vmc.orgs
|
||||
com.vmware.vmc.orgs
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,16 +20,14 @@ com.vmware.vmc.model\_client module
|
||||
-----------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.model_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
com.vmware.vmc.orgs\_client module
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
.. VMware Cloud on AWS Console API documentation master file, created by
|
||||
sphinx-quickstart on Tue Jun 4 12:24:36 2019.
|
||||
sphinx-quickstart on Sat Jun 8 04:29:08 2019.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
|
||||
@ -2,14 +2,13 @@ vmware package
|
||||
==============
|
||||
|
||||
.. automodule:: vmware
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
vmware.vapi
|
||||
|
||||
vmware.vapi
|
||||
|
||||
@ -2,14 +2,13 @@ vmware.vapi package
|
||||
===================
|
||||
|
||||
.. automodule:: vmware.vapi
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
vmware.vapi.vmc
|
||||
|
||||
vmware.vapi.vmc
|
||||
|
||||
@ -2,9 +2,9 @@ vmware.vapi.vmc package
|
||||
=======================
|
||||
|
||||
.. automodule:: vmware.vapi.vmc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,16 +13,14 @@ vmware.vapi.vmc.client module
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.vmc.client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
vmware.vapi.vmc.csp\_filter module
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.vmc.csp_filter
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 673 B |
@ -231,6 +231,16 @@ a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
a.brackets:before,
|
||||
span.brackets > a:before{
|
||||
content: "[";
|
||||
}
|
||||
|
||||
a.brackets:after,
|
||||
span.brackets > a:after {
|
||||
content: "]";
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
@ -279,6 +289,12 @@ img.align-center, .figure.align-center, object.align-center {
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
img.align-default, .figure.align-default {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left;
|
||||
}
|
||||
@ -287,6 +303,10 @@ img.align-center, .figure.align-center, object.align-center {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-default {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-right {
|
||||
text-align: right;
|
||||
}
|
||||
@ -358,6 +378,11 @@ table.align-center {
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-default {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
@ -391,6 +416,16 @@ table.citation td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
th > p:first-child,
|
||||
td > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
th > p:last-child,
|
||||
td > p:last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
@ -460,11 +495,57 @@ ol.upperroman {
|
||||
list-style: upper-roman;
|
||||
}
|
||||
|
||||
li > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
li > p:last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
dl.footnote > dt,
|
||||
dl.citation > dt {
|
||||
float: left;
|
||||
}
|
||||
|
||||
dl.footnote > dd,
|
||||
dl.citation > dd {
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl.footnote > dd:after,
|
||||
dl.citation > dd:after {
|
||||
content: "";
|
||||
clear: both;
|
||||
}
|
||||
|
||||
dl.field-list {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
dl.field-list > dt {
|
||||
flex-basis: 20%;
|
||||
font-weight: bold;
|
||||
word-break: break-word;
|
||||
}
|
||||
|
||||
dl.field-list > dt:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
dl.field-list > dd {
|
||||
flex-basis: 70%;
|
||||
padding-left: 1em;
|
||||
margin-left: 0em;
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd p {
|
||||
dd > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
@ -537,6 +618,12 @@ dl.glossary dt {
|
||||
font-style: oblique;
|
||||
}
|
||||
|
||||
.classifier:before {
|
||||
font-style: normal;
|
||||
margin: 0.5em;
|
||||
content: ":";
|
||||
}
|
||||
|
||||
abbr, acronym {
|
||||
border-bottom: dotted 1px;
|
||||
cursor: help;
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 756 B |
Binary file not shown.
|
Before Width: | Height: | Size: 829 B |
Binary file not shown.
|
Before Width: | Height: | Size: 641 B |
@ -87,14 +87,13 @@ jQuery.fn.highlightText = function(text, className) {
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
if (isInSVG) {
|
||||
var bbox = span.getBBox();
|
||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
var bbox = node.parentElement.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute('class', className);
|
||||
var parentOfText = node.parentNode.parentNode;
|
||||
addItems.push({
|
||||
"parent": node.parentNode,
|
||||
"target": rect});
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '1.5.0',
|
||||
VERSION: '1.6.0',
|
||||
LANGUAGE: 'en',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
NAVIGATION_WITH_KEYS: false,
|
||||
NAVIGATION_WITH_KEYS: false
|
||||
};
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 222 B |
Binary file not shown.
|
Before Width: | Height: | Size: 202 B |
@ -36,8 +36,10 @@ if (!Scorer) {
|
||||
|
||||
// query found in title
|
||||
title: 15,
|
||||
partialTitle: 7,
|
||||
// query found in terms
|
||||
term: 5
|
||||
term: 5,
|
||||
partialTerm: 2
|
||||
};
|
||||
}
|
||||
|
||||
@ -56,6 +58,14 @@ var Search = {
|
||||
_queued_query : null,
|
||||
_pulse_status : -1,
|
||||
|
||||
htmlToText : function(htmlString) {
|
||||
var htmlElement = document.createElement('span');
|
||||
htmlElement.innerHTML = htmlString;
|
||||
$(htmlElement).find('.headerlink').remove();
|
||||
docContent = $(htmlElement).find('[role=main]')[0];
|
||||
return docContent.textContent || docContent.innerText;
|
||||
},
|
||||
|
||||
init : function() {
|
||||
var params = $.getQueryParameters();
|
||||
if (params.q) {
|
||||
@ -120,7 +130,7 @@ var Search = {
|
||||
this.out = $('#search-results');
|
||||
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||
this.dots = $('<span></span>').appendTo(this.title);
|
||||
this.status = $('<p style="display: none"></p>').appendTo(this.out);
|
||||
this.status = $('<p class="search-summary"> </p>').appendTo(this.out);
|
||||
this.output = $('<ul class="search"/>').appendTo(this.out);
|
||||
|
||||
$('#search-progress').text(_('Preparing search...'));
|
||||
@ -259,11 +269,7 @@ var Search = {
|
||||
displayNextItem();
|
||||
});
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
|
||||
if (suffix === undefined) {
|
||||
suffix = '.txt';
|
||||
}
|
||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
|
||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
|
||||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
@ -313,12 +319,13 @@ var Search = {
|
||||
for (var prefix in objects) {
|
||||
for (var name in objects[prefix]) {
|
||||
var fullname = (prefix ? prefix + '.' : '') + name;
|
||||
if (fullname.toLowerCase().indexOf(object) > -1) {
|
||||
var fullnameLower = fullname.toLowerCase()
|
||||
if (fullnameLower.indexOf(object) > -1) {
|
||||
var score = 0;
|
||||
var parts = fullname.split('.');
|
||||
var parts = fullnameLower.split('.');
|
||||
// check for different match types: exact matches of full name or
|
||||
// "last name" (i.e. last dotted part)
|
||||
if (fullname == object || parts[parts.length - 1] == object) {
|
||||
if (fullnameLower == object || parts[parts.length - 1] == object) {
|
||||
score += Scorer.objNameMatch;
|
||||
// matches in last name
|
||||
} else if (parts[parts.length - 1].indexOf(object) > -1) {
|
||||
@ -385,6 +392,19 @@ var Search = {
|
||||
{files: terms[word], score: Scorer.term},
|
||||
{files: titleterms[word], score: Scorer.title}
|
||||
];
|
||||
// add support for partial matches
|
||||
if (word.length > 2) {
|
||||
for (var w in terms) {
|
||||
if (w.match(word) && !terms[word]) {
|
||||
_o.push({files: terms[w], score: Scorer.partialTerm})
|
||||
}
|
||||
}
|
||||
for (var w in titleterms) {
|
||||
if (w.match(word) && !titleterms[word]) {
|
||||
_o.push({files: titleterms[w], score: Scorer.partialTitle})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// no match but word was a required one
|
||||
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||
@ -424,8 +444,12 @@ var Search = {
|
||||
var valid = true;
|
||||
|
||||
// check if all requirements are matched
|
||||
if (fileMap[file].length != searchterms.length)
|
||||
continue;
|
||||
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
|
||||
searchterms.filter(function(term){return term.length > 2}).length
|
||||
if (
|
||||
fileMap[file].length != searchterms.length &&
|
||||
fileMap[file].length != filteredTermCount
|
||||
) continue;
|
||||
|
||||
// ensure that none of the excluded terms is in the search result
|
||||
for (i = 0; i < excluded.length; i++) {
|
||||
@ -456,7 +480,8 @@ var Search = {
|
||||
* words. the first one is used to find the occurrence, the
|
||||
* latter for highlighting it.
|
||||
*/
|
||||
makeSearchSummary : function(text, keywords, hlwords) {
|
||||
makeSearchSummary : function(htmlText, keywords, hlwords) {
|
||||
var text = Search.htmlToText(htmlText);
|
||||
var textLower = text.toLowerCase();
|
||||
var start = 0;
|
||||
$.each(keywords, function() {
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 214 B |
Binary file not shown.
|
Before Width: | Height: | Size: 203 B |
@ -1,808 +0,0 @@
|
||||
/*
|
||||
* websupport.js
|
||||
* ~~~~~~~~~~~~~
|
||||
*
|
||||
* sphinx.websupport utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
(function($) {
|
||||
$.fn.autogrow = function() {
|
||||
return this.each(function() {
|
||||
var textarea = this;
|
||||
|
||||
$.fn.autogrow.resize(textarea);
|
||||
|
||||
$(textarea)
|
||||
.focus(function() {
|
||||
textarea.interval = setInterval(function() {
|
||||
$.fn.autogrow.resize(textarea);
|
||||
}, 500);
|
||||
})
|
||||
.blur(function() {
|
||||
clearInterval(textarea.interval);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
$.fn.autogrow.resize = function(textarea) {
|
||||
var lineHeight = parseInt($(textarea).css('line-height'), 10);
|
||||
var lines = textarea.value.split('\n');
|
||||
var columns = textarea.cols;
|
||||
var lineCount = 0;
|
||||
$.each(lines, function() {
|
||||
lineCount += Math.ceil(this.length / columns) || 1;
|
||||
});
|
||||
var height = lineHeight * (lineCount + 1);
|
||||
$(textarea).css('height', height);
|
||||
};
|
||||
})(jQuery);
|
||||
|
||||
(function($) {
|
||||
var comp, by;
|
||||
|
||||
function init() {
|
||||
initEvents();
|
||||
initComparator();
|
||||
}
|
||||
|
||||
function initEvents() {
|
||||
$(document).on("click", 'a.comment-close', function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.vote', function(event) {
|
||||
event.preventDefault();
|
||||
handleVote($(this));
|
||||
});
|
||||
$(document).on("click", 'a.reply', function(event) {
|
||||
event.preventDefault();
|
||||
openReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.close-reply', function(event) {
|
||||
event.preventDefault();
|
||||
closeReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.sort-option', function(event) {
|
||||
event.preventDefault();
|
||||
handleReSort($(this));
|
||||
});
|
||||
$(document).on("click", 'a.show-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
showProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.hide-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.show-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
showProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.hide-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.accept-comment', function(event) {
|
||||
event.preventDefault();
|
||||
acceptComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.delete-comment', function(event) {
|
||||
event.preventDefault();
|
||||
deleteComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.comment-markup', function(event) {
|
||||
event.preventDefault();
|
||||
toggleCommentMarkupBox($(this).attr('id').substring(2));
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Set comp, which is a comparator function used for sorting and
|
||||
* inserting comments into the list.
|
||||
*/
|
||||
function setComparator() {
|
||||
// If the first three letters are "asc", sort in ascending order
|
||||
// and remove the prefix.
|
||||
if (by.substring(0,3) == 'asc') {
|
||||
var i = by.substring(3);
|
||||
comp = function(a, b) { return a[i] - b[i]; };
|
||||
} else {
|
||||
// Otherwise sort in descending order.
|
||||
comp = function(a, b) { return b[by] - a[by]; };
|
||||
}
|
||||
|
||||
// Reset link styles and format the selected sort option.
|
||||
$('a.sel').attr('href', '#').removeClass('sel');
|
||||
$('a.by' + by).removeAttr('href').addClass('sel');
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a comp function. If the user has preferences stored in
|
||||
* the sortBy cookie, use those, otherwise use the default.
|
||||
*/
|
||||
function initComparator() {
|
||||
by = 'rating'; // Default to sort by rating.
|
||||
// If the sortBy cookie is set, use that instead.
|
||||
if (document.cookie.length > 0) {
|
||||
var start = document.cookie.indexOf('sortBy=');
|
||||
if (start != -1) {
|
||||
start = start + 7;
|
||||
var end = document.cookie.indexOf(";", start);
|
||||
if (end == -1) {
|
||||
end = document.cookie.length;
|
||||
by = unescape(document.cookie.substring(start, end));
|
||||
}
|
||||
}
|
||||
}
|
||||
setComparator();
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a comment div.
|
||||
*/
|
||||
function show(id) {
|
||||
$('#ao' + id).hide();
|
||||
$('#ah' + id).show();
|
||||
var context = $.extend({id: id}, opts);
|
||||
var popup = $(renderTemplate(popupTemplate, context)).hide();
|
||||
popup.find('textarea[name="proposal"]').hide();
|
||||
popup.find('a.by' + by).addClass('sel');
|
||||
var form = popup.find('#cf' + id);
|
||||
form.submit(function(event) {
|
||||
event.preventDefault();
|
||||
addComment(form);
|
||||
});
|
||||
$('#s' + id).after(popup);
|
||||
popup.slideDown('fast', function() {
|
||||
getComments(id);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Hide a comment div.
|
||||
*/
|
||||
function hide(id) {
|
||||
$('#ah' + id).hide();
|
||||
$('#ao' + id).show();
|
||||
var div = $('#sc' + id);
|
||||
div.slideUp('fast', function() {
|
||||
div.remove();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Perform an ajax request to get comments for a node
|
||||
* and insert the comments into the comments tree.
|
||||
*/
|
||||
function getComments(id) {
|
||||
$.ajax({
|
||||
type: 'GET',
|
||||
url: opts.getCommentsURL,
|
||||
data: {node: id},
|
||||
success: function(data, textStatus, request) {
|
||||
var ul = $('#cl' + id);
|
||||
var speed = 100;
|
||||
$('#cf' + id)
|
||||
.find('textarea[name="proposal"]')
|
||||
.data('source', data.source);
|
||||
|
||||
if (data.comments.length === 0) {
|
||||
ul.html('<li>No comments yet.</li>');
|
||||
ul.data('empty', true);
|
||||
} else {
|
||||
// If there are comments, sort them and put them in the list.
|
||||
var comments = sortComments(data.comments);
|
||||
speed = data.comments.length * 100;
|
||||
appendComments(comments, ul);
|
||||
ul.data('empty', false);
|
||||
}
|
||||
$('#cn' + id).slideUp(speed + 200);
|
||||
ul.slideDown(speed);
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem retrieving the comments.');
|
||||
},
|
||||
dataType: 'json'
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a comment via ajax and insert the comment into the comment tree.
|
||||
*/
|
||||
function addComment(form) {
|
||||
var node_id = form.find('input[name="node"]').val();
|
||||
var parent_id = form.find('input[name="parent"]').val();
|
||||
var text = form.find('textarea[name="comment"]').val();
|
||||
var proposal = form.find('textarea[name="proposal"]').val();
|
||||
|
||||
if (text == '') {
|
||||
showError('Please enter a comment.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Disable the form that is being submitted.
|
||||
form.find('textarea,input').attr('disabled', 'disabled');
|
||||
|
||||
// Send the comment to the server.
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: opts.addCommentURL,
|
||||
dataType: 'json',
|
||||
data: {
|
||||
node: node_id,
|
||||
parent: parent_id,
|
||||
text: text,
|
||||
proposal: proposal
|
||||
},
|
||||
success: function(data, textStatus, error) {
|
||||
// Reset the form.
|
||||
if (node_id) {
|
||||
hideProposeChange(node_id);
|
||||
}
|
||||
form.find('textarea')
|
||||
.val('')
|
||||
.add(form.find('input'))
|
||||
.removeAttr('disabled');
|
||||
var ul = $('#cl' + (node_id || parent_id));
|
||||
if (ul.data('empty')) {
|
||||
$(ul).empty();
|
||||
ul.data('empty', false);
|
||||
}
|
||||
insertComment(data.comment);
|
||||
var ao = $('#ao' + node_id);
|
||||
ao.find('img').attr({'src': opts.commentBrightImage});
|
||||
if (node_id) {
|
||||
// if this was a "root" comment, remove the commenting box
|
||||
// (the user can get it back by reopening the comment popup)
|
||||
$('#ca' + node_id).slideUp();
|
||||
}
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
form.find('textarea,input').removeAttr('disabled');
|
||||
showError('Oops, there was a problem adding the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively append comments to the main comment list and children
|
||||
* lists, creating the comment tree.
|
||||
*/
|
||||
function appendComments(comments, ul) {
|
||||
$.each(comments, function() {
|
||||
var div = createCommentDiv(this);
|
||||
ul.append($(document.createElement('li')).html(div));
|
||||
appendComments(this.children, div.find('ul.comment-children'));
|
||||
// To avoid stagnating data, don't store the comments children in data.
|
||||
this.children = null;
|
||||
div.data('comment', this);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* After adding a new comment, it must be inserted in the correct
|
||||
* location in the comment tree.
|
||||
*/
|
||||
function insertComment(comment) {
|
||||
var div = createCommentDiv(comment);
|
||||
|
||||
// To avoid stagnating data, don't store the comments children in data.
|
||||
comment.children = null;
|
||||
div.data('comment', comment);
|
||||
|
||||
var ul = $('#cl' + (comment.node || comment.parent));
|
||||
var siblings = getChildren(ul);
|
||||
|
||||
var li = $(document.createElement('li'));
|
||||
li.hide();
|
||||
|
||||
// Determine where in the parents children list to insert this comment.
|
||||
for(var i=0; i < siblings.length; i++) {
|
||||
if (comp(comment, siblings[i]) <= 0) {
|
||||
$('#cd' + siblings[i].id)
|
||||
.parent()
|
||||
.before(li.html(div));
|
||||
li.slideDown('fast');
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// If we get here, this comment rates lower than all the others,
|
||||
// or it is the only comment in the list.
|
||||
ul.append(li.html(div));
|
||||
li.slideDown('fast');
|
||||
}
|
||||
|
||||
function acceptComment(id) {
|
||||
$.ajax({
|
||||
type: 'POST',
|
||||
url: opts.acceptCommentURL,
|
||||
data: {id: id},
|
||||
success: function(data, textStatus, request) {
|
||||
$('#cm' + id).fadeOut('fast');
|
||||
$('#cd' + id).removeClass('moderate');
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem accepting the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function deleteComment(id) {
|
||||
$.ajax({
|
||||
type: 'POST',
|
||||
url: opts.deleteCommentURL,
|
||||
data: {id: id},
|
||||
success: function(data, textStatus, request) {
|
||||
var div = $('#cd' + id);
|
||||
if (data == 'delete') {
|
||||
// Moderator mode: remove the comment and all children immediately
|
||||
div.slideUp('fast', function() {
|
||||
div.remove();
|
||||
});
|
||||
return;
|
||||
}
|
||||
// User mode: only mark the comment as deleted
|
||||
div
|
||||
.find('span.user-id:first')
|
||||
.text('[deleted]').end()
|
||||
.find('div.comment-text:first')
|
||||
.text('[deleted]').end()
|
||||
.find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
|
||||
', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
|
||||
.remove();
|
||||
var comment = div.data('comment');
|
||||
comment.username = '[deleted]';
|
||||
comment.text = '[deleted]';
|
||||
div.data('comment', comment);
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem deleting the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function showProposal(id) {
|
||||
$('#sp' + id).hide();
|
||||
$('#hp' + id).show();
|
||||
$('#pr' + id).slideDown('fast');
|
||||
}
|
||||
|
||||
function hideProposal(id) {
|
||||
$('#hp' + id).hide();
|
||||
$('#sp' + id).show();
|
||||
$('#pr' + id).slideUp('fast');
|
||||
}
|
||||
|
||||
function showProposeChange(id) {
|
||||
$('#pc' + id).hide();
|
||||
$('#hc' + id).show();
|
||||
var textarea = $('#pt' + id);
|
||||
textarea.val(textarea.data('source'));
|
||||
$.fn.autogrow.resize(textarea[0]);
|
||||
textarea.slideDown('fast');
|
||||
}
|
||||
|
||||
function hideProposeChange(id) {
|
||||
$('#hc' + id).hide();
|
||||
$('#pc' + id).show();
|
||||
var textarea = $('#pt' + id);
|
||||
textarea.val('').removeAttr('disabled');
|
||||
textarea.slideUp('fast');
|
||||
}
|
||||
|
||||
function toggleCommentMarkupBox(id) {
|
||||
$('#mb' + id).toggle();
|
||||
}
|
||||
|
||||
/** Handle when the user clicks on a sort by link. */
|
||||
function handleReSort(link) {
|
||||
var classes = link.attr('class').split(/\s+/);
|
||||
for (var i=0; i<classes.length; i++) {
|
||||
if (classes[i] != 'sort-option') {
|
||||
by = classes[i].substring(2);
|
||||
}
|
||||
}
|
||||
setComparator();
|
||||
// Save/update the sortBy cookie.
|
||||
var expiration = new Date();
|
||||
expiration.setDate(expiration.getDate() + 365);
|
||||
document.cookie= 'sortBy=' + escape(by) +
|
||||
';expires=' + expiration.toUTCString();
|
||||
$('ul.comment-ul').each(function(index, ul) {
|
||||
var comments = getChildren($(ul), true);
|
||||
comments = sortComments(comments);
|
||||
appendComments(comments, $(ul).empty());
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to process a vote when a user clicks an arrow.
|
||||
*/
|
||||
function handleVote(link) {
|
||||
if (!opts.voting) {
|
||||
showError("You'll need to login to vote.");
|
||||
return;
|
||||
}
|
||||
|
||||
var id = link.attr('id');
|
||||
if (!id) {
|
||||
// Didn't click on one of the voting arrows.
|
||||
return;
|
||||
}
|
||||
// If it is an unvote, the new vote value is 0,
|
||||
// Otherwise it's 1 for an upvote, or -1 for a downvote.
|
||||
var value = 0;
|
||||
if (id.charAt(1) != 'u') {
|
||||
value = id.charAt(0) == 'u' ? 1 : -1;
|
||||
}
|
||||
// The data to be sent to the server.
|
||||
var d = {
|
||||
comment_id: id.substring(2),
|
||||
value: value
|
||||
};
|
||||
|
||||
// Swap the vote and unvote links.
|
||||
link.hide();
|
||||
$('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
|
||||
.show();
|
||||
|
||||
// The div the comment is displayed in.
|
||||
var div = $('div#cd' + d.comment_id);
|
||||
var data = div.data('comment');
|
||||
|
||||
// If this is not an unvote, and the other vote arrow has
|
||||
// already been pressed, unpress it.
|
||||
if ((d.value !== 0) && (data.vote === d.value * -1)) {
|
||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
|
||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
|
||||
}
|
||||
|
||||
// Update the comments rating in the local data.
|
||||
data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
|
||||
data.vote = d.value;
|
||||
div.data('comment', data);
|
||||
|
||||
// Change the rating text.
|
||||
div.find('.rating:first')
|
||||
.text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
|
||||
|
||||
// Send the vote information to the server.
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: opts.processVoteURL,
|
||||
data: d,
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem casting that vote.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Open a reply form used to reply to an existing comment.
|
||||
*/
|
||||
function openReply(id) {
|
||||
// Swap out the reply link for the hide link
|
||||
$('#rl' + id).hide();
|
||||
$('#cr' + id).show();
|
||||
|
||||
// Add the reply li to the children ul.
|
||||
var div = $(renderTemplate(replyTemplate, {id: id})).hide();
|
||||
$('#cl' + id)
|
||||
.prepend(div)
|
||||
// Setup the submit handler for the reply form.
|
||||
.find('#rf' + id)
|
||||
.submit(function(event) {
|
||||
event.preventDefault();
|
||||
addComment($('#rf' + id));
|
||||
closeReply(id);
|
||||
})
|
||||
.find('input[type=button]')
|
||||
.click(function() {
|
||||
closeReply(id);
|
||||
});
|
||||
div.slideDown('fast', function() {
|
||||
$('#rf' + id).find('textarea').focus();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Close the reply form opened with openReply.
|
||||
*/
|
||||
function closeReply(id) {
|
||||
// Remove the reply div from the DOM.
|
||||
$('#rd' + id).slideUp('fast', function() {
|
||||
$(this).remove();
|
||||
});
|
||||
|
||||
// Swap out the hide link for the reply link
|
||||
$('#cr' + id).hide();
|
||||
$('#rl' + id).show();
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively sort a tree of comments using the comp comparator.
|
||||
*/
|
||||
function sortComments(comments) {
|
||||
comments.sort(comp);
|
||||
$.each(comments, function() {
|
||||
this.children = sortComments(this.children);
|
||||
});
|
||||
return comments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the children comments from a ul. If recursive is true,
|
||||
* recursively include childrens' children.
|
||||
*/
|
||||
function getChildren(ul, recursive) {
|
||||
var children = [];
|
||||
ul.children().children("[id^='cd']")
|
||||
.each(function() {
|
||||
var comment = $(this).data('comment');
|
||||
if (recursive)
|
||||
comment.children = getChildren($(this).find('#cl' + comment.id), true);
|
||||
children.push(comment);
|
||||
});
|
||||
return children;
|
||||
}
|
||||
|
||||
/** Create a div to display a comment in. */
|
||||
function createCommentDiv(comment) {
|
||||
if (!comment.displayed && !opts.moderator) {
|
||||
return $('<div class="moderate">Thank you! Your comment will show up '
|
||||
+ 'once it is has been approved by a moderator.</div>');
|
||||
}
|
||||
// Prettify the comment rating.
|
||||
comment.pretty_rating = comment.rating + ' point' +
|
||||
(comment.rating == 1 ? '' : 's');
|
||||
// Make a class (for displaying not yet moderated comments differently)
|
||||
comment.css_class = comment.displayed ? '' : ' moderate';
|
||||
// Create a div for this comment.
|
||||
var context = $.extend({}, opts, comment);
|
||||
var div = $(renderTemplate(commentTemplate, context));
|
||||
|
||||
// If the user has voted on this comment, highlight the correct arrow.
|
||||
if (comment.vote) {
|
||||
var direction = (comment.vote == 1) ? 'u' : 'd';
|
||||
div.find('#' + direction + 'v' + comment.id).hide();
|
||||
div.find('#' + direction + 'u' + comment.id).show();
|
||||
}
|
||||
|
||||
if (opts.moderator || comment.text != '[deleted]') {
|
||||
div.find('a.reply').show();
|
||||
if (comment.proposal_diff)
|
||||
div.find('#sp' + comment.id).show();
|
||||
if (opts.moderator && !comment.displayed)
|
||||
div.find('#cm' + comment.id).show();
|
||||
if (opts.moderator || (opts.username == comment.username))
|
||||
div.find('#dc' + comment.id).show();
|
||||
}
|
||||
return div;
|
||||
}
|
||||
|
||||
/**
|
||||
* A simple template renderer. Placeholders such as <%id%> are replaced
|
||||
* by context['id'] with items being escaped. Placeholders such as <#id#>
|
||||
* are not escaped.
|
||||
*/
|
||||
function renderTemplate(template, context) {
|
||||
var esc = $(document.createElement('div'));
|
||||
|
||||
function handle(ph, escape) {
|
||||
var cur = context;
|
||||
$.each(ph.split('.'), function() {
|
||||
cur = cur[this];
|
||||
});
|
||||
return escape ? esc.text(cur || "").html() : cur;
|
||||
}
|
||||
|
||||
return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
|
||||
return handle(arguments[2], arguments[1] == '%' ? true : false);
|
||||
});
|
||||
}
|
||||
|
||||
/** Flash an error message briefly. */
|
||||
function showError(message) {
|
||||
$(document.createElement('div')).attr({'class': 'popup-error'})
|
||||
.append($(document.createElement('div'))
|
||||
.attr({'class': 'error-message'}).text(message))
|
||||
.appendTo('body')
|
||||
.fadeIn("slow")
|
||||
.delay(2000)
|
||||
.fadeOut("slow");
|
||||
}
|
||||
|
||||
/** Add a link the user uses to open the comments popup. */
|
||||
$.fn.comment = function() {
|
||||
return this.each(function() {
|
||||
var id = $(this).attr('id').substring(1);
|
||||
var count = COMMENT_METADATA[id];
|
||||
var title = count + ' comment' + (count == 1 ? '' : 's');
|
||||
var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
|
||||
var addcls = count == 0 ? ' nocomment' : '';
|
||||
$(this)
|
||||
.append(
|
||||
$(document.createElement('a')).attr({
|
||||
href: '#',
|
||||
'class': 'sphinx-comment-open' + addcls,
|
||||
id: 'ao' + id
|
||||
})
|
||||
.append($(document.createElement('img')).attr({
|
||||
src: image,
|
||||
alt: 'comment',
|
||||
title: title
|
||||
}))
|
||||
.click(function(event) {
|
||||
event.preventDefault();
|
||||
show($(this).attr('id').substring(2));
|
||||
})
|
||||
)
|
||||
.append(
|
||||
$(document.createElement('a')).attr({
|
||||
href: '#',
|
||||
'class': 'sphinx-comment-close hidden',
|
||||
id: 'ah' + id
|
||||
})
|
||||
.append($(document.createElement('img')).attr({
|
||||
src: opts.closeCommentImage,
|
||||
alt: 'close',
|
||||
title: 'close'
|
||||
}))
|
||||
.click(function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
})
|
||||
);
|
||||
});
|
||||
};
|
||||
|
||||
var opts = {
|
||||
processVoteURL: '/_process_vote',
|
||||
addCommentURL: '/_add_comment',
|
||||
getCommentsURL: '/_get_comments',
|
||||
acceptCommentURL: '/_accept_comment',
|
||||
deleteCommentURL: '/_delete_comment',
|
||||
commentImage: '/static/_static/comment.png',
|
||||
closeCommentImage: '/static/_static/comment-close.png',
|
||||
loadingImage: '/static/_static/ajax-loader.gif',
|
||||
commentBrightImage: '/static/_static/comment-bright.png',
|
||||
upArrow: '/static/_static/up.png',
|
||||
downArrow: '/static/_static/down.png',
|
||||
upArrowPressed: '/static/_static/up-pressed.png',
|
||||
downArrowPressed: '/static/_static/down-pressed.png',
|
||||
voting: false,
|
||||
moderator: false
|
||||
};
|
||||
|
||||
if (typeof COMMENT_OPTIONS != "undefined") {
|
||||
opts = jQuery.extend(opts, COMMENT_OPTIONS);
|
||||
}
|
||||
|
||||
var popupTemplate = '\
|
||||
<div class="sphinx-comments" id="sc<%id%>">\
|
||||
<p class="sort-options">\
|
||||
Sort by:\
|
||||
<a href="#" class="sort-option byrating">best rated</a>\
|
||||
<a href="#" class="sort-option byascage">newest</a>\
|
||||
<a href="#" class="sort-option byage">oldest</a>\
|
||||
</p>\
|
||||
<div class="comment-header">Comments</div>\
|
||||
<div class="comment-loading" id="cn<%id%>">\
|
||||
loading comments... <img src="<%loadingImage%>" alt="" /></div>\
|
||||
<ul id="cl<%id%>" class="comment-ul"></ul>\
|
||||
<div id="ca<%id%>">\
|
||||
<p class="add-a-comment">Add a comment\
|
||||
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
|
||||
<div class="comment-markup-box" id="mb<%id%>">\
|
||||
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
|
||||
<code>``code``</code>, \
|
||||
code blocks: <code>::</code> and an indented block after blank line</div>\
|
||||
<form method="post" id="cf<%id%>" class="comment-form" action="">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<p class="propose-button">\
|
||||
<a href="#" id="pc<%id%>" class="show-propose-change">\
|
||||
Propose a change ▹\
|
||||
</a>\
|
||||
<a href="#" id="hc<%id%>" class="hide-propose-change">\
|
||||
Propose a change ▿\
|
||||
</a>\
|
||||
</p>\
|
||||
<textarea name="proposal" id="pt<%id%>" cols="80"\
|
||||
spellcheck="false"></textarea>\
|
||||
<input type="submit" value="Add comment" />\
|
||||
<input type="hidden" name="node" value="<%id%>" />\
|
||||
<input type="hidden" name="parent" value="" />\
|
||||
</form>\
|
||||
</div>\
|
||||
</div>';
|
||||
|
||||
var commentTemplate = '\
|
||||
<div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
|
||||
<div class="vote">\
|
||||
<div class="arrow">\
|
||||
<a href="#" id="uv<%id%>" class="vote" title="vote up">\
|
||||
<img src="<%upArrow%>" />\
|
||||
</a>\
|
||||
<a href="#" id="uu<%id%>" class="un vote" title="vote up">\
|
||||
<img src="<%upArrowPressed%>" />\
|
||||
</a>\
|
||||
</div>\
|
||||
<div class="arrow">\
|
||||
<a href="#" id="dv<%id%>" class="vote" title="vote down">\
|
||||
<img src="<%downArrow%>" id="da<%id%>" />\
|
||||
</a>\
|
||||
<a href="#" id="du<%id%>" class="un vote" title="vote down">\
|
||||
<img src="<%downArrowPressed%>" />\
|
||||
</a>\
|
||||
</div>\
|
||||
</div>\
|
||||
<div class="comment-content">\
|
||||
<p class="tagline comment">\
|
||||
<span class="user-id"><%username%></span>\
|
||||
<span class="rating"><%pretty_rating%></span>\
|
||||
<span class="delta"><%time.delta%></span>\
|
||||
</p>\
|
||||
<div class="comment-text comment"><#text#></div>\
|
||||
<p class="comment-opts comment">\
|
||||
<a href="#" class="reply hidden" id="rl<%id%>">reply ▹</a>\
|
||||
<a href="#" class="close-reply" id="cr<%id%>">reply ▿</a>\
|
||||
<a href="#" id="sp<%id%>" class="show-proposal">proposal ▹</a>\
|
||||
<a href="#" id="hp<%id%>" class="hide-proposal">proposal ▿</a>\
|
||||
<a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
|
||||
<span id="cm<%id%>" class="moderation hidden">\
|
||||
<a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
|
||||
</span>\
|
||||
</p>\
|
||||
<pre class="proposal" id="pr<%id%>">\
|
||||
<#proposal_diff#>\
|
||||
</pre>\
|
||||
<ul class="comment-children" id="cl<%id%>"></ul>\
|
||||
</div>\
|
||||
<div class="clearleft"></div>\
|
||||
</div>\
|
||||
</div>';
|
||||
|
||||
var replyTemplate = '\
|
||||
<li>\
|
||||
<div class="reply-div" id="rd<%id%>">\
|
||||
<form id="rf<%id%>">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<input type="submit" value="Add reply" />\
|
||||
<input type="button" value="Cancel" />\
|
||||
<input type="hidden" name="parent" value="<%id%>" />\
|
||||
<input type="hidden" name="node" value="" />\
|
||||
</form>\
|
||||
</div>\
|
||||
</li>';
|
||||
|
||||
$(document).ready(function() {
|
||||
init();
|
||||
});
|
||||
})(jQuery);
|
||||
|
||||
$(document).ready(function() {
|
||||
// add comment anchors for all paragraphs that are commentable
|
||||
$('.sphinx-has-comment').comment();
|
||||
|
||||
// highlight search words in search results
|
||||
$("div.context").each(function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.q) ? params.q[0].split(/\s+/) : [];
|
||||
var result = $(this);
|
||||
$.each(terms, function() {
|
||||
result.highlightText(this.toLowerCase(), 'highlighted');
|
||||
});
|
||||
});
|
||||
|
||||
// directly open comment window if requested
|
||||
var anchor = document.location.hash;
|
||||
if (anchor.substring(0, 9) == '#comment-') {
|
||||
$('#ao' + anchor.substring(9)).click();
|
||||
document.location.hash = '#s' + anchor.substring(9);
|
||||
}
|
||||
});
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com package — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>com package — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware package — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>com.vmware package — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -262,120 +262,114 @@
|
||||
<span id="com-vmware-vmc-client-module"></span><h2>com.vmware.vmc_client module<a class="headerlink" href="#module-com.vmware.vmc_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc_client.Locale">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc_client.</code><code class="descname">Locale</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Locale" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc_client.</code><code class="sig-name descname">Locale</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Locale" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc_client.Locale.set">
|
||||
<code class="descname">set</code><span class="sig-paren">(</span><em>vmc_locale</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Locale.set" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">vmc_locale</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Locale.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the locale for the session which is used for translating
|
||||
responses.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vmc_locale</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.VmcLocale" title="com.vmware.vmc.model_client.VmcLocale"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.VmcLocale</span></code></a>) – The locale to be set. (required)</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.VmcLocale" title="com.vmware.vmc.model_client.VmcLocale"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.VmcLocale</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.vmc.model.VmcLocale</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
Unauthorized</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>vmc_locale</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.VmcLocale" title="com.vmware.vmc.model_client.VmcLocale"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.VmcLocale</span></code></a>) – The locale to be set. (required)</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.VmcLocale" title="com.vmware.vmc.model_client.VmcLocale"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.VmcLocale</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.VmcLocale</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
Unauthorized</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc_client.Orgs">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc_client.</code><code class="descname">Orgs</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Orgs" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc_client.</code><code class="sig-name descname">Orgs</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Orgs" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc_client.Orgs.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Orgs.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Orgs.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get details of organization</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Organization" title="com.vmware.vmc.model_client.Organization"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Organization</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.vmc.model.Organization</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
Unauthorized</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Organization doesn’t exist</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Organization" title="com.vmware.vmc.model_client.Organization"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Organization</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.Organization</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
Unauthorized</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Organization doesn’t exist</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc_client.Orgs.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Orgs.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Orgs.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return a list of all organizations the calling user (based on
|
||||
credential) is authorized on.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vmc_client.Orgs.list" title="com.vmware.vmc_client.Orgs.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Organization" title="com.vmware.vmc.model_client.Organization"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Organization</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
Unauthorized</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vmc_client.Orgs.list" title="com.vmware.vmc_client.Orgs.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Organization" title="com.vmware.vmc.model_client.Organization"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Organization</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
Unauthorized</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.cgws package — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.cgws package — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -184,132 +184,114 @@
|
||||
<span id="com-vmware-vmc-orgs-sddcs-networks-cgws-l2vpn-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.</code><code class="descname">Config</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.</code><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete SDDC L2 VPN configuration.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute Gateway Edge Identifier (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute Gateway Edge Identifier (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>show_sensitive_data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">show_sensitive_data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve SDDC L2 VPN configuration.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute Gateway Edge Identifier (required)</li>
|
||||
<li><strong>show_sensitive_data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute Gateway Edge Identifier (required)</p></li>
|
||||
<li><p><strong>show_sensitive_data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxl2vpn" title="com.vmware.vmc.model_client.Nsxl2vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxl2vpn</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Nsxl2vpn</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxl2vpn" title="com.vmware.vmc.model_client.Nsxl2vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxl2vpn</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.Nsxl2vpn</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>nsxl2vpn</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.update" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">nsxl2vpn</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Modify SDDC L2 VPN configuration</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute Gateway Edge Identifier (required)</li>
|
||||
<li><strong>nsxl2vpn</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxl2vpn" title="com.vmware.vmc.model_client.Nsxl2vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxl2vpn</span></code></a>) – (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute Gateway Edge Identifier (required)</p></li>
|
||||
<li><p><strong>nsxl2vpn</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxl2vpn" title="com.vmware.vmc.model_client.Nsxl2vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxl2vpn</span></code></a>) – (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.firewall package — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.firewall package — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,169 +186,147 @@
|
||||
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-firewall-config-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.</code><code class="descname">Rules</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.</code><code class="sig-name descname">Rules</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.add">
|
||||
<code class="descname">add</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>firewall_rules</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.add" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">firewall_rules</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Append firewall rules for a management or compute gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>firewall_rules</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.FirewallRules" title="com.vmware.vmc.model_client.FirewallRules"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.FirewallRules</span></code></a>) – (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>firewall_rules</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.FirewallRules" title="com.vmware.vmc.model_client.FirewallRules"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.FirewallRules</span></code></a>) – (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete a specific firewall rule for a management or compute gateway
|
||||
(NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve a specific firewall rule for a management or compute gateway
|
||||
(NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxfirewallrule" title="com.vmware.vmc.model_client.Nsxfirewallrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxfirewallrule</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Nsxfirewallrule</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxfirewallrule" title="com.vmware.vmc.model_client.Nsxfirewallrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxfirewallrule</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.Nsxfirewallrule</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>rule_id</em>, <em>nsxfirewallrule</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.update" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">rule_id</em>, <em class="sig-param">nsxfirewallrule</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Modify the specified firewall rule for a management or compute gateway
|
||||
(NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</li>
|
||||
<li><strong>nsxfirewallrule</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxfirewallrule" title="com.vmware.vmc.model_client.Nsxfirewallrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxfirewallrule</span></code></a>) – (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</p></li>
|
||||
<li><p><strong>nsxfirewallrule</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxfirewallrule" title="com.vmware.vmc.model_client.Nsxfirewallrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxfirewallrule</span></code></a>) – (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,68 +186,58 @@
|
||||
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-l2vpn-config-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.</code><code class="descname">Statistics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.</code><code class="sig-name descname">Statistics</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve L2 VPN statistics for a compute gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.L2vpnStatusAndStats" title="com.vmware.vmc.model_client.L2vpnStatusAndStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.L2vpnStatusAndStats</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.L2vpnStatusAndStats</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.L2vpnStatusAndStats" title="com.vmware.vmc.model_client.L2vpnStatusAndStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.L2vpnStatusAndStats</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.L2vpnStatusAndStats</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.nat package — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.nat package — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,130 +186,112 @@
|
||||
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-nat-config-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.</code><code class="descname">Rules</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.</code><code class="sig-name descname">Rules</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.add">
|
||||
<code class="descname">add</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>nat_rules</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.add" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">nat_rules</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Append a NAT rule for a management or compute gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>nat_rules</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NatRules" title="com.vmware.vmc.model_client.NatRules"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NatRules</span></code></a>) – (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>nat_rules</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NatRules" title="com.vmware.vmc.model_client.NatRules"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NatRules</span></code></a>) – (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete the specific NAT rule for a management or compute gateway (NSX
|
||||
Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>rule_id</em>, <em>nsxnatrule</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.update" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">rule_id</em>, <em class="sig-param">nsxnatrule</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Update the specific NAT rule for a management or compute gateway (NSX
|
||||
Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</li>
|
||||
<li><strong>nsxnatrule</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxnatrule" title="com.vmware.vmc.model_client.Nsxnatrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxnatrule</span></code></a>) – (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</p></li>
|
||||
<li><p><strong>nsxnatrule</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxnatrule" title="com.vmware.vmc.model_client.Nsxnatrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxnatrule</span></code></a>) – (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.statistics package — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.statistics package — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,179 +186,155 @@
|
||||
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-statistics-dashboard-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.</code><code class="descname">Firewall</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.</code><code class="sig-name descname">Firewall</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>interval=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">interval=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve firewall dashboard statistics for a management or compute
|
||||
gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
|
||||
oneMonth, oneYear. (optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
|
||||
oneMonth, oneYear. (optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.DashboardStatistics" title="com.vmware.vmc.model_client.DashboardStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DashboardStatistics</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.DashboardStatistics</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.DashboardStatistics" title="com.vmware.vmc.model_client.DashboardStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DashboardStatistics</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.DashboardStatistics</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.</code><code class="descname">Interface</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.</code><code class="sig-name descname">Interface</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>interval=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">interval=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve interface dashboard statistics for a management or compute
|
||||
gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
|
||||
oneMonth, oneYear. (optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
|
||||
oneMonth, oneYear. (optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.DashboardStatistics" title="com.vmware.vmc.model_client.DashboardStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DashboardStatistics</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.DashboardStatistics</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.DashboardStatistics" title="com.vmware.vmc.model_client.DashboardStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DashboardStatistics</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.DashboardStatistics</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.</code><code class="descname">Ipsec</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.</code><code class="sig-name descname">Ipsec</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>interval=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">interval=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve ipsec dashboard statistics for a management or compute gateway
|
||||
(NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
|
||||
oneMonth, oneYear. (optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
|
||||
oneMonth, oneYear. (optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.DashboardStatistics" title="com.vmware.vmc.model_client.DashboardStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DashboardStatistics</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.DashboardStatistics</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.DashboardStatistics" title="com.vmware.vmc.model_client.DashboardStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DashboardStatistics</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.DashboardStatistics</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -366,127 +342,110 @@ Not found. Requested object not found.</p>
|
||||
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-statistics-interfaces-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.</code><code class="descname">Internal</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.</code><code class="sig-name descname">Internal</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>start_time=None</em>, <em>end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve internal interface statistics for a management or compute
|
||||
gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Show statistics from this start time (in milliseconds since epoch).
|
||||
(optional)</li>
|
||||
<li><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Show statistics until this end time (in milliseconds since epoch).
|
||||
(optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Show statistics from this start time (in milliseconds since epoch).
|
||||
(optional)</p></li>
|
||||
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Show statistics until this end time (in milliseconds since epoch).
|
||||
(optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.CbmStatistics" title="com.vmware.vmc.model_client.CbmStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.CbmStatistics</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.CbmStatistics</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.CbmStatistics" title="com.vmware.vmc.model_client.CbmStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.CbmStatistics</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.CbmStatistics</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.</code><code class="descname">Uplink</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.</code><code class="sig-name descname">Uplink</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>start_time=None</em>, <em>end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve uplink interface statistics for a management or compute
|
||||
gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Show statistics from this start time (in milliseconds since epoch).
|
||||
(optional)</li>
|
||||
<li><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Show statistics until this end time (in milliseconds since epoch).
|
||||
(optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Show statistics from this start time (in milliseconds since epoch).
|
||||
(optional)</p></li>
|
||||
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Show statistics until this end time (in milliseconds since epoch).
|
||||
(optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.CbmStatistics" title="com.vmware.vmc.model_client.CbmStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.CbmStatistics</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.CbmStatistics</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.CbmStatistics" title="com.vmware.vmc.model_client.CbmStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.CbmStatistics</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.CbmStatistics</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks package — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks package — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -228,183 +228,159 @@
|
||||
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.edges_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges_client.</code><code class="descname">Peerconfig</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges_client.</code><code class="sig-name descname">Peerconfig</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>objecttype</em>, <em>objectid</em>, <em>templateid=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">objecttype</em>, <em class="sig-param">objectid</em>, <em class="sig-param">templateid=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve IPsec VPN peer configuration for a management or compute
|
||||
gateway (NSX Edge). The response output is free form text generated as
|
||||
per the template specified as request parameter input.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>objecttype</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Specify object type identifier. Valid value is ‘ipsecSiteConfig’.
|
||||
Required. (required)</li>
|
||||
<li><strong>objectid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Specify object identifier, for example ‘ipsecsite-1’ for IPsec Site
|
||||
configuration. Required. (required)</li>
|
||||
<li><strong>templateid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specify template identifier and response format. Valid values are
|
||||
‘text’, ‘json’ and ‘xml’. Default is ‘text’. Optional. (optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>objecttype</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Specify object type identifier. Valid value is ‘ipsecSiteConfig’.
|
||||
Required. (required)</p></li>
|
||||
<li><p><strong>objectid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Specify object identifier, for example ‘ipsecsite-1’ for IPsec Site
|
||||
configuration. Required. (required)</p></li>
|
||||
<li><p><strong>templateid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specify template identifier and response format. Valid values are
|
||||
‘text’, ‘json’ and ‘xml’. Default is ‘text’. Optional. (optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">DynamicStructure</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>DynamicStructure</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges_client.Status">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges_client.Status.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>getlatest=None</em>, <em>detailed=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em>, <em class="sig-param">getlatest=None</em>, <em class="sig-param">detailed=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve the status of the specified management or compute gateway (NSX
|
||||
Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>getlatest</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If true, retrieve the status live from the gateway (NSX Edge). If
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>getlatest</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If true, retrieve the status live from the gateway (NSX Edge). If
|
||||
false, retrieve the latest available status from database.
|
||||
(optional)</li>
|
||||
<li><strong>detailed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If true, retrieve detailed status per feature. If false, retrieve
|
||||
aggregated summary of status per feature. (optional)</li>
|
||||
(optional)</p></li>
|
||||
<li><p><strong>detailed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If true, retrieve detailed status per feature. If false, retrieve
|
||||
aggregated summary of status per feature. (optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.EdgeStatus" title="com.vmware.vmc.model_client.EdgeStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.EdgeStatus</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.EdgeStatus</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.EdgeStatus" title="com.vmware.vmc.model_client.EdgeStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.EdgeStatus</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.EdgeStatus</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges_client.</code><code class="descname">Vnics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges_client.</code><code class="sig-name descname">Vnics</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">edge_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve all interfaces for the specified management or compute gateway
|
||||
(NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Vnics" title="com.vmware.vmc.model_client.Vnics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Vnics</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Vnics</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Vnics" title="com.vmware.vmc.model_client.Vnics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Vnics</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.Vnics</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
Forbidden. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
Not found. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Interface definition language to python mapping for enumerated types — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>Interface definition language to python mapping for enumerated types — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -58,7 +58,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -160,25 +160,24 @@ language. The special class contains class attributes which represent
|
||||
the values of the enumerated type.</p>
|
||||
<p>This documentation explains the following:</p>
|
||||
<ul class="simple">
|
||||
<li>How the class variables are defined in the module. This specifies the names that you can use in your program.</li>
|
||||
<li>How you instantiate a class to use it for communication with future versions of the service.</li>
|
||||
<li><p>How the class variables are defined in the module. This specifies the names that you can use in your program.</p></li>
|
||||
<li><p>How you instantiate a class to use it for communication with future versions of the service.</p></li>
|
||||
</ul>
|
||||
<div class="section" id="example-of-an-enumerated-type-documentation">
|
||||
<h2>Example of an enumerated type documentation<a class="headerlink" href="#example-of-an-enumerated-type-documentation" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="docutils">
|
||||
<dt><em>class</em> com.vmware.vapi.metadata_client. <strong>SourceType</strong> (string)</dt>
|
||||
<dd><p class="first">Bases: vmware.vapi.bindings.enum.Enum</p>
|
||||
<dl>
|
||||
<dt><em>class</em> com.vmware.vapi.metadata_client. <strong>SourceType</strong> (string)</dt><dd><p>Bases: vmware.vapi.bindings.enum.Enum</p>
|
||||
<p>Metadata source type</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See <a class="reference internal" href="#enumeration-description"><span class="std std-ref">enumerated type description page</span></a>.</p>
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See <a class="reference internal" href="#enumeration-description"><span class="std std-ref">enumerated type description page</span></a>.</p>
|
||||
</div>
|
||||
<p><strong>Parameters</strong> : <strong>string</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>) – String value for the SourceType instance.</p>
|
||||
<dl class="last docutils">
|
||||
<dt><strong>FILE</strong> = <em>SourceType(string=’FILE’)</em></dt>
|
||||
<dd>If the source is backed by a file.</dd>
|
||||
<dt><strong>REMOTE</strong> = <em>SourceType(string=’REMOTE’)</em></dt>
|
||||
<dd>If the source is backed by a remote service.</dd>
|
||||
<dl class="simple">
|
||||
<dt><strong>FILE</strong> = <em>SourceType(string=’FILE’)</em></dt><dd><p>If the source is backed by a file.</p>
|
||||
</dd>
|
||||
<dt><strong>REMOTE</strong> = <em>SourceType(string=’REMOTE’)</em></dt><dd><p>If the source is backed by a remote service.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
@ -188,7 +187,7 @@ the values of the enumerated type.</p>
|
||||
<p>The enumerated type classes are defined in python modules that your code
|
||||
imports. You can use these in your code.</p>
|
||||
<ol class="arabic simple">
|
||||
<li>If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class.</li>
|
||||
<li><p>If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class.</p></li>
|
||||
</ol>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># SourceType is an enumerated type</span>
|
||||
<span class="kn">from</span> <span class="nn">com.vmware.vapi.metadata_client</span> <span class="kn">import</span> <span class="n">SourceType</span>
|
||||
@ -199,7 +198,7 @@ imports. You can use these in your code.</p>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ol class="arabic simple" start="2">
|
||||
<li>When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values.</li>
|
||||
<li><p>When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values.</p></li>
|
||||
</ol>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># SourceType is an enumerated type</span>
|
||||
<span class="kn">from</span> <span class="nn">com.vmware.vapi.metadata_client</span> <span class="kn">import</span> <span class="n">SourceType</span>
|
||||
@ -215,7 +214,7 @@ imports. You can use these in your code.</p>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ol class="arabic simple" start="3">
|
||||
<li>Sending a new enumerated type value to a server that has a newer version of the enumerated type.</li>
|
||||
<li><p>Sending a new enumerated type value to a server that has a newer version of the enumerated type.</p></li>
|
||||
</ol>
|
||||
<p>To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate the
|
||||
enumerated type class.</p>
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Index — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>Index — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -280,8 +280,6 @@
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.CloudProvider">CloudProvider (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Cluster">Cluster (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Cluster.cluster_id">cluster_id (com.vmware.vmc.model_client.Cluster attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_ADDING_HOSTS">CLUSTER_STATE_ADDING_HOSTS (com.vmware.vmc.model_client.Cluster attribute)</a>
|
||||
</li>
|
||||
@ -349,10 +347,10 @@
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client">com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client (module)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat_client">com.vmware.vmc.orgs.sddcs.networks.edges.nat_client (module)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics">com.vmware.vmc.orgs.sddcs.networks.edges.statistics (module)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client (module)</a>
|
||||
@ -1077,30 +1075,30 @@
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Organization.PROJECT_STATE_DELETED">PROJECT_STATE_DELETED (com.vmware.vmc.model_client.Organization attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Agent.provider">provider (com.vmware.vmc.model_client.Agent attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Agent.provider">provider() (com.vmware.vmc.model_client.Agent property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsAgent.provider">(com.vmware.vmc.model_client.AwsAgent attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsAgent.provider">(com.vmware.vmc.model_client.AwsAgent property)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsCloudProvider.provider">(com.vmware.vmc.model_client.AwsCloudProvider attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsCloudProvider.provider">(com.vmware.vmc.model_client.AwsCloudProvider property)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsEsxHost.provider">(com.vmware.vmc.model_client.AwsEsxHost attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsEsxHost.provider">(com.vmware.vmc.model_client.AwsEsxHost property)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsSddcConfig.provider">(com.vmware.vmc.model_client.AwsSddcConfig attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsSddcConfig.provider">(com.vmware.vmc.model_client.AwsSddcConfig property)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsSddcResourceConfig.provider">(com.vmware.vmc.model_client.AwsSddcResourceConfig attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsSddcResourceConfig.provider">(com.vmware.vmc.model_client.AwsSddcResourceConfig property)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.CloudProvider.provider">(com.vmware.vmc.model_client.CloudProvider attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.CloudProvider.provider">(com.vmware.vmc.model_client.CloudProvider property)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.EsxHost.provider">(com.vmware.vmc.model_client.EsxHost attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.EsxHost.provider">(com.vmware.vmc.model_client.EsxHost property)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcConfig.provider">(com.vmware.vmc.model_client.SddcConfig attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcConfig.provider">(com.vmware.vmc.model_client.SddcConfig property)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcResourceConfig.provider">(com.vmware.vmc.model_client.SddcResourceConfig attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcResourceConfig.provider">(com.vmware.vmc.model_client.SddcResourceConfig property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Sddc.PROVIDER_AWS">PROVIDER_AWS (com.vmware.vmc.model_client.Sddc attribute)</a>
|
||||
|
||||
<ul>
|
||||
@ -1112,6 +1110,10 @@
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.orgs_client.Providers">Providers (class in com.vmware.vmc.orgs_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.dns_client.Public">Public (class in com.vmware.vmc.orgs.sddcs.dns_client)</a>
|
||||
</li>
|
||||
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.client.PUBLIC_CSP_URL">PUBLIC_CSP_URL (in module vmware.vapi.vmc.client)</a>
|
||||
</li>
|
||||
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.client.PUBLIC_VMC_URL">PUBLIC_VMC_URL (in module vmware.vapi.vmc.client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.sddcs_client.Publicips">Publicips (class in com.vmware.vmc.orgs.sddcs_client)</a>
|
||||
</li>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Welcome to VMware Cloud on AWS Console API’s documentation! — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>Welcome to VMware Cloud on AWS Console API’s documentation! — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -226,9 +226,9 @@
|
||||
<div class="section" id="indices-and-tables">
|
||||
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
|
||||
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
|
||||
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
|
||||
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
BIN
vmc/objects.inv
BIN
vmc/objects.inv
Binary file not shown.
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Python Module Index — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>Python Module Index — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Search — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>Search — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>vmware package — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>vmware package — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>vmware.vapi package — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>vmware.vapi package — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>vmware.vapi.vmc package — VMware Cloud on AWS Console API 1.5.0 documentation</title>
|
||||
<title>vmware.vapi.vmc package — VMware Cloud on AWS Console API 1.6.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.5.0
|
||||
1.6.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -172,54 +172,56 @@
|
||||
<div class="section" id="module-vmware.vapi.vmc.client">
|
||||
<span id="vmware-vapi-vmc-client-module"></span><h2>vmware.vapi.vmc.client module<a class="headerlink" href="#module-vmware.vapi.vmc.client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>CSP Refresh token based SecurityContextFilter</p>
|
||||
<dl class="data">
|
||||
<dt id="vmware.vapi.vmc.client.PUBLIC_CSP_URL">
|
||||
<code class="sig-prename descclassname">vmware.vapi.vmc.client.</code><code class="sig-name descname">PUBLIC_CSP_URL</code><em class="property"> = 'https://console.cloud.vmware.com'</em><a class="headerlink" href="#vmware.vapi.vmc.client.PUBLIC_CSP_URL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="data">
|
||||
<dt id="vmware.vapi.vmc.client.PUBLIC_VMC_URL">
|
||||
<code class="sig-prename descclassname">vmware.vapi.vmc.client.</code><code class="sig-name descname">PUBLIC_VMC_URL</code><em class="property"> = 'https://vmc.vmware.com/'</em><a class="headerlink" href="#vmware.vapi.vmc.client.PUBLIC_VMC_URL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="vmware.vapi.vmc.client.VmcClient">
|
||||
<em class="property">class </em><code class="descclassname">vmware.vapi.vmc.client.</code><code class="descname">VmcClient</code><span class="sig-paren">(</span><em>session</em>, <em>refresh_token</em>, <em>vmc_url</em>, <em>csp_url</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.client.VmcClient" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.vmc.client.</code><code class="sig-name descname">VmcClient</code><span class="sig-paren">(</span><em class="sig-param">session</em>, <em class="sig-param">refresh_token</em>, <em class="sig-param">vmc_url</em>, <em class="sig-param">csp_url</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.client.VmcClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.ApiClient</span></code></p>
|
||||
<p>VMC Client class that providess access to stubs for all the services in the
|
||||
VMC API</p>
|
||||
<p>Initialize VmcClient by creating a stub factory instance using a CSP
|
||||
Security context filter added to the filter chain of the connector</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||||
<li><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Requests HTTP session instance</li>
|
||||
<li><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Refresh token obtained from CSP</li>
|
||||
<li><strong>vmc_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the VMC service</li>
|
||||
<li><strong>csp_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the CSP service</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Requests HTTP session instance</p></li>
|
||||
<li><p><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Refresh token obtained from CSP</p></li>
|
||||
<li><p><strong>vmc_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the VMC service</p></li>
|
||||
<li><p><strong>csp_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the CSP service</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="vmware.vapi.vmc.client.create_vmc_client">
|
||||
<code class="descclassname">vmware.vapi.vmc.client.</code><code class="descname">create_vmc_client</code><span class="sig-paren">(</span><em>refresh_token</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.client.create_vmc_client" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-prename descclassname">vmware.vapi.vmc.client.</code><code class="sig-name descname">create_vmc_client</code><span class="sig-paren">(</span><em class="sig-param">refresh_token</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.client.create_vmc_client" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Helper method to create an instance of the VMC API client using the public
|
||||
VMC and CSP URL.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Refresh token obtained from CSP</li>
|
||||
<li><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Requests HTTP session instance. If not specified, then one
|
||||
is automatically created and used</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Refresh token obtained from CSP</p></li>
|
||||
<li><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Requests HTTP session instance. If not specified, then one
|
||||
is automatically created and used</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#vmware.vapi.vmc.client.VmcClient" title="vmware.vapi.vmc.client.VmcClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.vmc.client.VmcClient</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">VMC Client instance</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#vmware.vapi.vmc.client.VmcClient" title="vmware.vapi.vmc.client.VmcClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.vmc.client.VmcClient</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>VMC Client instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -228,79 +230,71 @@ is automatically created and used</li>
|
||||
<p>CSP Refresh token based SecurityContextFilter</p>
|
||||
<dl class="class">
|
||||
<dt id="vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter">
|
||||
<em class="property">class </em><code class="descclassname">vmware.vapi.vmc.csp_filter.</code><code class="descname">CSPSecurityContextFilter</code><span class="sig-paren">(</span><em>session</em>, <em>refresh_token</em>, <em>refresh_url</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.vmc.csp_filter.</code><code class="sig-name descname">CSPSecurityContextFilter</code><span class="sig-paren">(</span><em class="sig-param">session</em>, <em class="sig-param">refresh_token</em>, <em class="sig-param">refresh_url</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.security.client.security_context_filter.SecurityContextFilter</span></code></p>
|
||||
<p>CSP Security Context filter in API Provider chain adds the security
|
||||
context based on a refresh token to the execution context passed in.</p>
|
||||
<p>Initialize SecurityContextFilter</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||||
<li><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Requests Session object to use for making HTTP calls</li>
|
||||
<li><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Refresh token to use for obtaining an access token</li>
|
||||
<li><strong>refresh_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL that allows exchanging a refresh token for an
|
||||
access token</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Requests Session object to use for making HTTP calls</p></li>
|
||||
<li><p><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Refresh token to use for obtaining an access token</p></li>
|
||||
<li><p><strong>refresh_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL that allows exchanging a refresh token for an
|
||||
access token</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_max_retries">
|
||||
<code class="descname">get_max_retries</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_max_retries" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get_max_retries</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_max_retries" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the max number of retries</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Number of retries</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Number of retries</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_security_context">
|
||||
<code class="descname">get_security_context</code><span class="sig-paren">(</span><em>on_error</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_security_context" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get_security_context</code><span class="sig-paren">(</span><em class="sig-param">on_error</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_security_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve security context. If this method is called after an error
|
||||
occured, then a new access token is obtained using the refresh token and
|
||||
a new security context is created.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>on_error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether this method is called after getting an error</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Security context</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>on_error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether this method is called after getting an error</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Security context</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.should_retry">
|
||||
<code class="descname">should_retry</code><span class="sig-paren">(</span><em>error_value</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.should_retry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">should_retry</code><span class="sig-paren">(</span><em class="sig-param">error_value</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.should_retry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns whether the request should be retried or not based on the error
|
||||
specified.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>error_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.ErrorValue</span></code>) – Method error</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns True if request should be retried in case the error is
|
||||
either Unauthenticated or Unauthorized else False</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>error_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.ErrorValue</span></code>) – Method error</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Returns True if request should be retried in case the error is
|
||||
either Unauthenticated or Unauthorized else False</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user