mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-26 03:10:00 -05:00
Updating latest python vmc-draas doc (4cad160)
This commit is contained in:
amanp
parent
5a27fba324
commit
286f65d2e6
@ -2,14 +2,13 @@ com package
|
|||||||
===========
|
===========
|
||||||
|
|
||||||
.. automodule:: com
|
.. automodule:: com
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
Subpackages
|
Subpackages
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
||||||
com.vmware
|
com.vmware
|
||||||
|
|
||||||
|
|||||||
@ -2,14 +2,13 @@ com.vmware package
|
|||||||
==================
|
==================
|
||||||
|
|
||||||
.. automodule:: com.vmware
|
.. automodule:: com.vmware
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
Subpackages
|
Subpackages
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
||||||
com.vmware.vmc
|
com.vmware.vmc
|
||||||
|
|
||||||
|
|||||||
@ -2,9 +2,9 @@ com.vmware.vmc.draas package
|
|||||||
============================
|
============================
|
||||||
|
|
||||||
.. automodule:: com.vmware.vmc.draas
|
.. automodule:: com.vmware.vmc.draas
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
Submodules
|
Submodules
|
||||||
----------
|
----------
|
||||||
@ -13,8 +13,7 @@ com.vmware.vmc.draas.model\_client module
|
|||||||
-----------------------------------------
|
-----------------------------------------
|
||||||
|
|
||||||
.. automodule:: com.vmware.vmc.draas.model_client
|
.. automodule:: com.vmware.vmc.draas.model_client
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -2,16 +2,16 @@ com.vmware.vmc package
|
|||||||
======================
|
======================
|
||||||
|
|
||||||
.. automodule:: com.vmware.vmc
|
.. automodule:: com.vmware.vmc
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
Subpackages
|
Subpackages
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
||||||
com.vmware.vmc.draas
|
com.vmware.vmc.draas
|
||||||
|
|
||||||
Submodules
|
Submodules
|
||||||
----------
|
----------
|
||||||
@ -20,8 +20,7 @@ com.vmware.vmc.draas\_client module
|
|||||||
-----------------------------------
|
-----------------------------------
|
||||||
|
|
||||||
.. automodule:: com.vmware.vmc.draas_client
|
.. automodule:: com.vmware.vmc.draas_client
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
82
vmc-draas/_sources/enumeration.rst.txt
Normal file
82
vmc-draas/_sources/enumeration.rst.txt
Normal file
@ -0,0 +1,82 @@
|
|||||||
|
.. _enumeration_description:
|
||||||
|
|
||||||
|
Interface definition language to python mapping for enumerated types
|
||||||
|
--------------------------------------------------------------------
|
||||||
|
|
||||||
|
The interface language definition type system includes enumerated types. Python
|
||||||
|
SDK supports both 2.x and 3.x versions of Python. Since Python 2.x does
|
||||||
|
not have first class support for enumerations, special classes are
|
||||||
|
generated to represent enumerated types from the interface definition
|
||||||
|
language. The special class contains class attributes which represent
|
||||||
|
the values of the enumerated type.
|
||||||
|
|
||||||
|
This documentation explains the following:
|
||||||
|
|
||||||
|
* How the class variables are defined in the module. This specifies the names that you can use in your program.
|
||||||
|
* How you instantiate a class to use it for communication with future versions of the service.
|
||||||
|
|
||||||
|
Example of an enumerated type documentation
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
*class* com.vmware.vapi.metadata_client. **SourceType** (string)
|
||||||
|
Bases: vmware.vapi.bindings.enum.Enum
|
||||||
|
|
||||||
|
Metadata source type
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
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 :ref:`enumerated type description page <enumeration_description>`.
|
||||||
|
|
||||||
|
**Parameters** : **string** (``str``) – String value for the SourceType instance.
|
||||||
|
|
||||||
|
**FILE** = *SourceType(string='FILE')*
|
||||||
|
If the source is backed by a file.
|
||||||
|
|
||||||
|
**REMOTE** = *SourceType(string='REMOTE')*
|
||||||
|
If the source is backed by a remote service.
|
||||||
|
|
||||||
|
Code Examples
|
||||||
|
^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
The enumerated type classes are defined in python modules that your code
|
||||||
|
imports. You can use these in your code.
|
||||||
|
|
||||||
|
1. If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class.
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
# SourceType is an enumerated type
|
||||||
|
from com.vmware.vapi.metadata_client import SourceType
|
||||||
|
|
||||||
|
# SourceType has two class attrites, SourceType.FILE and SourceType.REMOTE
|
||||||
|
spec = Source.CreateSpec(type=SourceType.FILE, filepath='entity_metadata.json', description='Entity service')
|
||||||
|
source_svc.create(id='entity', spec=spec)
|
||||||
|
|
||||||
|
2. When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values.
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
# SourceType is an enumerated type
|
||||||
|
from com.vmware.vapi.metadata_client import SourceType
|
||||||
|
|
||||||
|
source_info = source_svc.get(id='entity')
|
||||||
|
if (source_info.type == SourceType.FILE) {
|
||||||
|
print 'Source is a file'
|
||||||
|
} else if (source_info.type == SourceType.REMOTE) {
|
||||||
|
print 'Source is a remote provider'
|
||||||
|
} else {
|
||||||
|
print 'Unknown source type: %s' % str(source_info.type)
|
||||||
|
}
|
||||||
|
|
||||||
|
3. Sending a new enumerated type value to a server that has a newer version of the enumerated type.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
# If a newer version of SourceType has a new value FOLDER, FOLDER would be one
|
||||||
|
# of the class attributes for SourceType. In the older version, SourceType has
|
||||||
|
# only two class attributes, FILE and REMOTE
|
||||||
|
from com.vmware.vapi.metadata_client import SourceType
|
||||||
|
spec = Source.CreateSpec(type=SourceType('FOLDER'), filepath='entity_metadata', description='Entity service')
|
||||||
|
source_svc.create(id='entity', spec=spec)
|
||||||
@ -1,10 +1,10 @@
|
|||||||
.. vAPI documentation master file, created by
|
.. draas documentation master file, created by
|
||||||
sphinx-quickstart on Fri Sep 6 13:52:42 2019.
|
sphinx-quickstart on Mon Nov 4 10:29:19 2019.
|
||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
Welcome to vAPI's documentation!
|
Welcome to draas's documentation!
|
||||||
================================
|
=================================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 10
|
:maxdepth: 10
|
||||||
|
|||||||
@ -2,14 +2,13 @@ vmware package
|
|||||||
==============
|
==============
|
||||||
|
|
||||||
.. automodule:: vmware
|
.. automodule:: vmware
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
Subpackages
|
Subpackages
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
||||||
vmware.vapi
|
vmware.vapi
|
||||||
|
|
||||||
|
|||||||
@ -2,14 +2,13 @@ vmware.vapi package
|
|||||||
===================
|
===================
|
||||||
|
|
||||||
.. automodule:: vmware.vapi
|
.. automodule:: vmware.vapi
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
Subpackages
|
Subpackages
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
||||||
vmware.vapi.vmc
|
vmware.vapi.vmc
|
||||||
|
|
||||||
|
|||||||
@ -2,9 +2,9 @@ vmware.vapi.vmc package
|
|||||||
=======================
|
=======================
|
||||||
|
|
||||||
.. automodule:: vmware.vapi.vmc
|
.. automodule:: vmware.vapi.vmc
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
Submodules
|
Submodules
|
||||||
----------
|
----------
|
||||||
@ -13,16 +13,15 @@ vmware.vapi.vmc.client module
|
|||||||
-----------------------------
|
-----------------------------
|
||||||
|
|
||||||
.. automodule:: vmware.vapi.vmc.client
|
.. automodule:: vmware.vapi.vmc.client
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
vmware.vapi.vmc.csp\_filter module
|
vmware.vapi.vmc.csp\_filter module
|
||||||
----------------------------------
|
----------------------------------
|
||||||
|
|
||||||
.. automodule:: vmware.vapi.vmc.csp_filter
|
.. automodule:: vmware.vapi.vmc.csp_filter
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 673 B |
@ -231,6 +231,16 @@ a.headerlink {
|
|||||||
visibility: hidden;
|
visibility: hidden;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
a.brackets:before,
|
||||||
|
span.brackets > a:before{
|
||||||
|
content: "[";
|
||||||
|
}
|
||||||
|
|
||||||
|
a.brackets:after,
|
||||||
|
span.brackets > a:after {
|
||||||
|
content: "]";
|
||||||
|
}
|
||||||
|
|
||||||
h1:hover > a.headerlink,
|
h1:hover > a.headerlink,
|
||||||
h2:hover > a.headerlink,
|
h2:hover > a.headerlink,
|
||||||
h3:hover > a.headerlink,
|
h3:hover > a.headerlink,
|
||||||
@ -279,6 +289,12 @@ img.align-center, .figure.align-center, object.align-center {
|
|||||||
margin-right: auto;
|
margin-right: auto;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
img.align-default, .figure.align-default {
|
||||||
|
display: block;
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
}
|
||||||
|
|
||||||
.align-left {
|
.align-left {
|
||||||
text-align: left;
|
text-align: left;
|
||||||
}
|
}
|
||||||
@ -287,6 +303,10 @@ img.align-center, .figure.align-center, object.align-center {
|
|||||||
text-align: center;
|
text-align: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.align-default {
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
.align-right {
|
.align-right {
|
||||||
text-align: right;
|
text-align: right;
|
||||||
}
|
}
|
||||||
@ -358,6 +378,11 @@ table.align-center {
|
|||||||
margin-right: auto;
|
margin-right: auto;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
table.align-default {
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
}
|
||||||
|
|
||||||
table caption span.caption-number {
|
table caption span.caption-number {
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
}
|
}
|
||||||
@ -391,6 +416,16 @@ table.citation td {
|
|||||||
border-bottom: none;
|
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 --------------------------------------------------------------- */
|
/* -- figures --------------------------------------------------------------- */
|
||||||
|
|
||||||
div.figure {
|
div.figure {
|
||||||
@ -460,11 +495,58 @@ ol.upperroman {
|
|||||||
list-style: upper-roman;
|
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: grid;
|
||||||
|
grid-template-columns: fit-content(30%) auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.field-list > dt {
|
||||||
|
font-weight: bold;
|
||||||
|
word-break: break-word;
|
||||||
|
padding-left: 0.5em;
|
||||||
|
padding-right: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.field-list > dt:after {
|
||||||
|
content: ":";
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.field-list > dd {
|
||||||
|
padding-left: 0.5em;
|
||||||
|
margin-top: 0em;
|
||||||
|
margin-left: 0em;
|
||||||
|
margin-bottom: 0em;
|
||||||
|
}
|
||||||
|
|
||||||
dl {
|
dl {
|
||||||
margin-bottom: 15px;
|
margin-bottom: 15px;
|
||||||
}
|
}
|
||||||
|
|
||||||
dd p {
|
dd > p:first-child {
|
||||||
margin-top: 0px;
|
margin-top: 0px;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -537,6 +619,12 @@ dl.glossary dt {
|
|||||||
font-style: oblique;
|
font-style: oblique;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.classifier:before {
|
||||||
|
font-style: normal;
|
||||||
|
margin: 0.5em;
|
||||||
|
content: ":";
|
||||||
|
}
|
||||||
|
|
||||||
abbr, acronym {
|
abbr, acronym {
|
||||||
border-bottom: dotted 1px;
|
border-bottom: dotted 1px;
|
||||||
cursor: help;
|
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.nextSibling));
|
||||||
node.nodeValue = val.substr(0, pos);
|
node.nodeValue = val.substr(0, pos);
|
||||||
if (isInSVG) {
|
if (isInSVG) {
|
||||||
var bbox = span.getBBox();
|
|
||||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
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.y.baseVal.value = bbox.y;
|
||||||
rect.width.baseVal.value = bbox.width;
|
rect.width.baseVal.value = bbox.width;
|
||||||
rect.height.baseVal.value = bbox.height;
|
rect.height.baseVal.value = bbox.height;
|
||||||
rect.setAttribute('class', className);
|
rect.setAttribute('class', className);
|
||||||
var parentOfText = node.parentNode.parentNode;
|
|
||||||
addItems.push({
|
addItems.push({
|
||||||
"parent": node.parentNode,
|
"parent": node.parentNode,
|
||||||
"target": rect});
|
"target": rect});
|
||||||
|
|||||||
@ -1,10 +1,10 @@
|
|||||||
var DOCUMENTATION_OPTIONS = {
|
var DOCUMENTATION_OPTIONS = {
|
||||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||||
VERSION: '1.9.0',
|
VERSION: '1.1.0',
|
||||||
LANGUAGE: 'None',
|
LANGUAGE: 'en',
|
||||||
COLLAPSE_INDEX: false,
|
COLLAPSE_INDEX: false,
|
||||||
FILE_SUFFIX: '.html',
|
FILE_SUFFIX: '.html',
|
||||||
HAS_SOURCE: true,
|
HAS_SOURCE: true,
|
||||||
SOURCELINK_SUFFIX: '.txt',
|
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 |
File diff suppressed because it is too large
Load Diff
6
vmc-draas/_static/jquery.js
vendored
6
vmc-draas/_static/jquery.js
vendored
File diff suppressed because one or more lines are too long
@ -1,69 +1,69 @@
|
|||||||
.highlight .hll { background-color: #ffffcc }
|
.highlight .hll { background-color: #ffffcc }
|
||||||
.highlight { background: #eeffcc; }
|
.highlight { background: #f8f8f8; }
|
||||||
.highlight .c { color: #408090; font-style: italic } /* Comment */
|
.highlight .c { color: #408080; font-style: italic } /* Comment */
|
||||||
.highlight .err { border: 1px solid #FF0000 } /* Error */
|
.highlight .err { border: 1px solid #FF0000 } /* Error */
|
||||||
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
|
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
|
||||||
.highlight .o { color: #666666 } /* Operator */
|
.highlight .o { color: #666666 } /* Operator */
|
||||||
.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
|
.highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */
|
||||||
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
|
.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
|
||||||
.highlight .cp { color: #007020 } /* Comment.Preproc */
|
.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
|
||||||
.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
|
.highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */
|
||||||
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
|
.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
|
||||||
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
|
.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
|
||||||
.highlight .gd { color: #A00000 } /* Generic.Deleted */
|
.highlight .gd { color: #A00000 } /* Generic.Deleted */
|
||||||
.highlight .ge { font-style: italic } /* Generic.Emph */
|
.highlight .ge { font-style: italic } /* Generic.Emph */
|
||||||
.highlight .gr { color: #FF0000 } /* Generic.Error */
|
.highlight .gr { color: #FF0000 } /* Generic.Error */
|
||||||
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
||||||
.highlight .gi { color: #00A000 } /* Generic.Inserted */
|
.highlight .gi { color: #00A000 } /* Generic.Inserted */
|
||||||
.highlight .go { color: #333333 } /* Generic.Output */
|
.highlight .go { color: #888888 } /* Generic.Output */
|
||||||
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
|
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
|
||||||
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
||||||
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
||||||
.highlight .gt { color: #0044DD } /* Generic.Traceback */
|
.highlight .gt { color: #0044DD } /* Generic.Traceback */
|
||||||
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
|
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
|
||||||
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
|
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
|
||||||
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
|
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
|
||||||
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
|
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
|
||||||
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
|
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
|
||||||
.highlight .kt { color: #902000 } /* Keyword.Type */
|
.highlight .kt { color: #B00040 } /* Keyword.Type */
|
||||||
.highlight .m { color: #208050 } /* Literal.Number */
|
.highlight .m { color: #666666 } /* Literal.Number */
|
||||||
.highlight .s { color: #4070a0 } /* Literal.String */
|
.highlight .s { color: #BA2121 } /* Literal.String */
|
||||||
.highlight .na { color: #4070a0 } /* Name.Attribute */
|
.highlight .na { color: #7D9029 } /* Name.Attribute */
|
||||||
.highlight .nb { color: #007020 } /* Name.Builtin */
|
.highlight .nb { color: #008000 } /* Name.Builtin */
|
||||||
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
|
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
|
||||||
.highlight .no { color: #60add5 } /* Name.Constant */
|
.highlight .no { color: #880000 } /* Name.Constant */
|
||||||
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
|
.highlight .nd { color: #AA22FF } /* Name.Decorator */
|
||||||
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
|
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
|
||||||
.highlight .ne { color: #007020 } /* Name.Exception */
|
.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
|
||||||
.highlight .nf { color: #06287e } /* Name.Function */
|
.highlight .nf { color: #0000FF } /* Name.Function */
|
||||||
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
|
.highlight .nl { color: #A0A000 } /* Name.Label */
|
||||||
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
|
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
|
||||||
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
|
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
|
||||||
.highlight .nv { color: #bb60d5 } /* Name.Variable */
|
.highlight .nv { color: #19177C } /* Name.Variable */
|
||||||
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
|
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
|
||||||
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
||||||
.highlight .mb { color: #208050 } /* Literal.Number.Bin */
|
.highlight .mb { color: #666666 } /* Literal.Number.Bin */
|
||||||
.highlight .mf { color: #208050 } /* Literal.Number.Float */
|
.highlight .mf { color: #666666 } /* Literal.Number.Float */
|
||||||
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
|
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
|
||||||
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
|
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
|
||||||
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
|
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
|
||||||
.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
|
.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
|
||||||
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
|
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
|
||||||
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
|
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
|
||||||
.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
|
.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
|
||||||
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
|
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
|
||||||
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
|
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
|
||||||
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
|
.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
|
||||||
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
|
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
|
||||||
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
|
.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
|
||||||
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
|
.highlight .sx { color: #008000 } /* Literal.String.Other */
|
||||||
.highlight .sr { color: #235388 } /* Literal.String.Regex */
|
.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
|
||||||
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
|
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
|
||||||
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
|
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
|
||||||
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
|
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
|
||||||
.highlight .fm { color: #06287e } /* Name.Function.Magic */
|
.highlight .fm { color: #0000FF } /* Name.Function.Magic */
|
||||||
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
|
.highlight .vc { color: #19177C } /* Name.Variable.Class */
|
||||||
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
|
.highlight .vg { color: #19177C } /* Name.Variable.Global */
|
||||||
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
|
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
|
||||||
.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
|
.highlight .vm { color: #19177C } /* Name.Variable.Magic */
|
||||||
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
|
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
|
||||||
@ -36,8 +36,10 @@ if (!Scorer) {
|
|||||||
|
|
||||||
// query found in title
|
// query found in title
|
||||||
title: 15,
|
title: 15,
|
||||||
|
partialTitle: 7,
|
||||||
// query found in terms
|
// query found in terms
|
||||||
term: 5
|
term: 5,
|
||||||
|
partialTerm: 2
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -56,6 +58,14 @@ var Search = {
|
|||||||
_queued_query : null,
|
_queued_query : null,
|
||||||
_pulse_status : -1,
|
_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() {
|
init : function() {
|
||||||
var params = $.getQueryParameters();
|
var params = $.getQueryParameters();
|
||||||
if (params.q) {
|
if (params.q) {
|
||||||
@ -120,7 +130,7 @@ var Search = {
|
|||||||
this.out = $('#search-results');
|
this.out = $('#search-results');
|
||||||
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||||
this.dots = $('<span></span>').appendTo(this.title);
|
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);
|
this.output = $('<ul class="search"/>').appendTo(this.out);
|
||||||
|
|
||||||
$('#search-progress').text(_('Preparing search...'));
|
$('#search-progress').text(_('Preparing search...'));
|
||||||
@ -259,11 +269,7 @@ var Search = {
|
|||||||
displayNextItem();
|
displayNextItem();
|
||||||
});
|
});
|
||||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||||
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
|
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
|
||||||
if (suffix === undefined) {
|
|
||||||
suffix = '.txt';
|
|
||||||
}
|
|
||||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
|
|
||||||
dataType: "text",
|
dataType: "text",
|
||||||
complete: function(jqxhr, textstatus) {
|
complete: function(jqxhr, textstatus) {
|
||||||
var data = jqxhr.responseText;
|
var data = jqxhr.responseText;
|
||||||
@ -313,12 +319,13 @@ var Search = {
|
|||||||
for (var prefix in objects) {
|
for (var prefix in objects) {
|
||||||
for (var name in objects[prefix]) {
|
for (var name in objects[prefix]) {
|
||||||
var fullname = (prefix ? prefix + '.' : '') + name;
|
var fullname = (prefix ? prefix + '.' : '') + name;
|
||||||
if (fullname.toLowerCase().indexOf(object) > -1) {
|
var fullnameLower = fullname.toLowerCase()
|
||||||
|
if (fullnameLower.indexOf(object) > -1) {
|
||||||
var score = 0;
|
var score = 0;
|
||||||
var parts = fullname.split('.');
|
var parts = fullnameLower.split('.');
|
||||||
// check for different match types: exact matches of full name or
|
// check for different match types: exact matches of full name or
|
||||||
// "last name" (i.e. last dotted part)
|
// "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;
|
score += Scorer.objNameMatch;
|
||||||
// matches in last name
|
// matches in last name
|
||||||
} else if (parts[parts.length - 1].indexOf(object) > -1) {
|
} else if (parts[parts.length - 1].indexOf(object) > -1) {
|
||||||
@ -385,6 +392,19 @@ var Search = {
|
|||||||
{files: terms[word], score: Scorer.term},
|
{files: terms[word], score: Scorer.term},
|
||||||
{files: titleterms[word], score: Scorer.title}
|
{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
|
// no match but word was a required one
|
||||||
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||||
@ -424,8 +444,12 @@ var Search = {
|
|||||||
var valid = true;
|
var valid = true;
|
||||||
|
|
||||||
// check if all requirements are matched
|
// check if all requirements are matched
|
||||||
if (fileMap[file].length != searchterms.length)
|
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
|
||||||
continue;
|
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
|
// ensure that none of the excluded terms is in the search result
|
||||||
for (i = 0; i < excluded.length; i++) {
|
for (i = 0; i < excluded.length; i++) {
|
||||||
@ -456,7 +480,8 @@ var Search = {
|
|||||||
* words. the first one is used to find the occurrence, the
|
* words. the first one is used to find the occurrence, the
|
||||||
* latter for highlighting it.
|
* latter for highlighting it.
|
||||||
*/
|
*/
|
||||||
makeSearchSummary : function(text, keywords, hlwords) {
|
makeSearchSummary : function(htmlText, keywords, hlwords) {
|
||||||
|
var text = Search.htmlToText(htmlText);
|
||||||
var textLower = text.toLowerCase();
|
var textLower = text.toLowerCase();
|
||||||
var start = 0;
|
var start = 0;
|
||||||
$.each(keywords, function() {
|
$.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">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com package — vSphere Automation SDK for Python 1.9.0 documentation</title>
|
<title>com package — draas 1.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -36,7 +36,7 @@
|
|||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware package" href="com.vmware.html" />
|
<link rel="next" title="com.vmware package" href="com.vmware.html" />
|
||||||
<link rel="prev" title="Welcome to vAPI’s documentation!" href="index.html" />
|
<link rel="prev" title="Welcome to draas’s documentation!" href="index.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
@ -50,7 +50,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
<a href="index.html" class="icon icon-home"> draas
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -60,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
1.9.0
|
1.1.0
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -108,7 +108,7 @@
|
|||||||
<nav class="wy-nav-top" aria-label="top navigation">
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
<a href="index.html">vSphere Automation SDK for Python</a>
|
<a href="index.html">draas</a>
|
||||||
|
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
@ -199,7 +199,7 @@
|
|||||||
<a href="com.vmware.html" class="btn btn-neutral float-right" title="com.vmware package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.html" class="btn btn-neutral float-right" title="com.vmware package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to vAPI’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to draas’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -208,10 +208,11 @@
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2019, VMware, Inc. All rights reserved
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
</footer>
|
</footer>
|
||||||
|
|
||||||
|
|||||||
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware package — vSphere Automation SDK for Python 1.9.0 documentation</title>
|
<title>com.vmware package — draas 1.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -50,7 +50,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
<a href="index.html" class="icon icon-home"> draas
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -60,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
1.9.0
|
1.1.0
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -111,7 +111,7 @@
|
|||||||
<nav class="wy-nav-top" aria-label="top navigation">
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
<a href="index.html">vSphere Automation SDK for Python</a>
|
<a href="index.html">draas</a>
|
||||||
|
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
@ -207,10 +207,11 @@
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2019, VMware, Inc. All rights reserved
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
</footer>
|
</footer>
|
||||||
|
|
||||||
|
|||||||
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.vmc.draas package — vSphere Automation SDK for Python 1.9.0 documentation</title>
|
<title>com.vmware.vmc.draas package — draas 1.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -50,7 +50,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
<a href="index.html" class="icon icon-home"> draas
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -60,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
1.9.0
|
1.1.0
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -111,7 +111,7 @@
|
|||||||
<nav class="wy-nav-top" aria-label="top navigation">
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
<a href="index.html">vSphere Automation SDK for Python</a>
|
<a href="index.html">draas</a>
|
||||||
|
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
@ -176,534 +176,484 @@
|
|||||||
<span id="com-vmware-vmc-draas-model-client-module"></span><h2>com.vmware.vmc.draas.model_client module<a class="headerlink" href="#module-com.vmware.vmc.draas.model_client" title="Permalink to this headline">¶</a></h2>
|
<span id="com-vmware-vmc-draas-model-client-module"></span><h2>com.vmware.vmc.draas.model_client module<a class="headerlink" href="#module-com.vmware.vmc.draas.model_client" title="Permalink to this headline">¶</a></h2>
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.AbstractEntity">
|
<dt id="com.vmware.vmc.draas.model_client.AbstractEntity">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">AbstractEntity</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>created=None</em>, <em>updated_by_user_id=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.AbstractEntity" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_client.</code><code class="sig-name descname">AbstractEntity</code><span class="sig-paren">(</span><em class="sig-param">updated=None</em>, <em class="sig-param">user_id=None</em>, <em class="sig-param">created=None</em>, <em class="sig-param">updated_by_user_id=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">updated_by_user_name=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.AbstractEntity" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="first admonition-title">Tip</p>
|
<p class="admonition-title">Tip</p>
|
||||||
<p class="last">The arguments are used to initialize data attributes with the same
|
<p>The arguments are used to initialize data attributes with the same
|
||||||
names.</p>
|
names.</p>
|
||||||
</div>
|
</div>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
<li><p><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</p></li>
|
||||||
<li><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
<li><p><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </p></li>
|
||||||
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
<li><p><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</p></li>
|
||||||
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</p></li>
|
||||||
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
<li><p><strong>updated_by_user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</p></li>
|
||||||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
|
<li><p><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</p></li>
|
||||||
<li><strong>updated_by_user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||||
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
|
||||||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig">
|
<dt id="com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">ActivateSiteRecoveryConfig</code><span class="sig-paren">(</span><em>srm_extension_key_suffix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_client.</code><code class="sig-name descname">ActivateSiteRecoveryConfig</code><span class="sig-paren">(</span><em class="sig-param">srm_extension_key_suffix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="first admonition-title">Tip</p>
|
<p class="admonition-title">Tip</p>
|
||||||
<p class="last">The arguments are used to initialize data attributes with the same
|
<p>The arguments are used to initialize data attributes with the same
|
||||||
names.</p>
|
names.</p>
|
||||||
</div>
|
</div>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>srm_extension_key_suffix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional custom extension key suffix for SRM. If not specified,
|
||||||
<tbody valign="top">
|
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>srm_extension_key_suffix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional custom extension key suffix for SRM. If not specified,
|
|
||||||
default extension key will be used. The custom extension suffix
|
default extension key will be used. The custom extension suffix
|
||||||
must contain 13 characters or less, be composed of letters,
|
must contain 13 characters or less, be composed of letters,
|
||||||
numbers, ., -, and _ characters. The extension suffix must begin
|
numbers, ., -, and _ characters. The extension suffix must begin
|
||||||
and end with a letter or number. The suffix is appended to
|
and end with a letter or number. The suffix is appended to
|
||||||
com.vmware.vcDr- to form the full extension key.</td>
|
com.vmware.vcDr- to form the full extension key.</p>
|
||||||
</tr>
|
</dd>
|
||||||
</tbody>
|
</dl>
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.ErrorResponse">
|
<dt id="com.vmware.vmc.draas.model_client.ErrorResponse">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">ErrorResponse</code><span class="sig-paren">(</span><em>status=None</em>, <em>path=None</em>, <em>retryable=None</em>, <em>error_code=None</em>, <em>error_messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ErrorResponse" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_client.</code><code class="sig-name descname">ErrorResponse</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">path=None</em>, <em class="sig-param">retryable=None</em>, <em class="sig-param">error_code=None</em>, <em class="sig-param">error_messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ErrorResponse" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="first admonition-title">Tip</p>
|
<p class="admonition-title">Tip</p>
|
||||||
<p class="last">The arguments are used to initialize data attributes with the same
|
<p>The arguments are used to initialize data attributes with the same
|
||||||
names.</p>
|
names.</p>
|
||||||
</div>
|
</div>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – HTTP status code</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Originating request URI</p></li>
|
||||||
<li><strong>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – HTTP status code</li>
|
<li><p><strong>retryable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – If true, client should retry operation</p></li>
|
||||||
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Originating request URI</li>
|
<li><p><strong>error_code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique error code</p></li>
|
||||||
<li><strong>retryable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – If true, client should retry operation</li>
|
<li><p><strong>error_messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – localized error messages</p></li>
|
||||||
<li><strong>error_code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique error code</li>
|
|
||||||
<li><strong>error_messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – localized error messages</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.ProvisionSrmConfig">
|
<dt id="com.vmware.vmc.draas.model_client.ProvisionSrmConfig">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">ProvisionSrmConfig</code><span class="sig-paren">(</span><em>internal=None</em>, <em>srm_extension_key_suffix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ProvisionSrmConfig" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_client.</code><code class="sig-name descname">ProvisionSrmConfig</code><span class="sig-paren">(</span><em class="sig-param">internal=None</em>, <em class="sig-param">srm_extension_key_suffix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ProvisionSrmConfig" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="first admonition-title">Tip</p>
|
<p class="admonition-title">Tip</p>
|
||||||
<p class="last">The arguments are used to initialize data attributes with the same
|
<p>The arguments are used to initialize data attributes with the same
|
||||||
names.</p>
|
names.</p>
|
||||||
</div>
|
</div>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>internal</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>) – Internal flag to allow to invoke additional SRM provisioning API on
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
NSX-V SDDCs.</p></li>
|
||||||
<li><strong>internal</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>) – Internal flag to allow to invoke additional SRM provisioning API on
|
<li><p><strong>srm_extension_key_suffix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional custom extension key suffix for SRM. If not specified,
|
||||||
NSX-V SDDCs.</li>
|
default extension key will be used.</p></li>
|
||||||
<li><strong>srm_extension_key_suffix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional custom extension key suffix for SRM. If not specified,
|
|
||||||
default extension key will be used.</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.ReplicaDisk">
|
<dt id="com.vmware.vmc.draas.model_client.ReplicaDisk">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">ReplicaDisk</code><span class="sig-paren">(</span><em>space_requirement=None</em>, <em>name=None</em>, <em>collection_id=None</em>, <em>datastores_for_single_host_move=None</em>, <em>movable=None</em>, <em>disk_id=None</em>, <em>datastore_mo_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ReplicaDisk" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_client.</code><code class="sig-name descname">ReplicaDisk</code><span class="sig-paren">(</span><em class="sig-param">space_requirement=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">collection_id=None</em>, <em class="sig-param">datastores_for_single_host_move=None</em>, <em class="sig-param">movable=None</em>, <em class="sig-param">disk_id=None</em>, <em class="sig-param">datastore_mo_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ReplicaDisk" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="first admonition-title">Tip</p>
|
<p class="admonition-title">Tip</p>
|
||||||
<p class="last">The arguments are used to initialize data attributes with the same
|
<p>The arguments are used to initialize data attributes with the same
|
||||||
names.</p>
|
names.</p>
|
||||||
</div>
|
</div>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>space_requirement</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>space_requirement</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>collection_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>datastores_for_single_host_move</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>collection_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>movable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>datastores_for_single_host_move</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>disk_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>movable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>datastore_mo_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>disk_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
|
||||||
<li><strong>datastore_mo_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.ReplicaDiskCollection">
|
<dt id="com.vmware.vmc.draas.model_client.ReplicaDiskCollection">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">ReplicaDiskCollection</code><span class="sig-paren">(</span><em>collection_id=None</em>, <em>generated=None</em>, <em>disks=None</em>, <em>placeholder_vm_mo_id=None</em>, <em>name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ReplicaDiskCollection" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_client.</code><code class="sig-name descname">ReplicaDiskCollection</code><span class="sig-paren">(</span><em class="sig-param">collection_id=None</em>, <em class="sig-param">generated=None</em>, <em class="sig-param">disks=None</em>, <em class="sig-param">placeholder_vm_mo_id=None</em>, <em class="sig-param">name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ReplicaDiskCollection" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="first admonition-title">Tip</p>
|
<p class="admonition-title">Tip</p>
|
||||||
<p class="last">The arguments are used to initialize data attributes with the same
|
<p>The arguments are used to initialize data attributes with the same
|
||||||
names.</p>
|
names.</p>
|
||||||
</div>
|
</div>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>collection_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
<li><p><strong>generated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>collection_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.draas.model_client.ReplicaDisk" title="com.vmware.vmc.draas.model_client.ReplicaDisk"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicaDisk</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>generated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>placeholder_vm_mo_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.draas.model_client.ReplicaDisk" title="com.vmware.vmc.draas.model_client.ReplicaDisk"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicaDisk</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>placeholder_vm_mo_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
|
||||||
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">SiteRecovery</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>created=None</em>, <em>updated_by_user_id=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em>, <em>site_recovery_state=None</em>, <em>vr_node=None</em>, <em>srm_nodes=None</em>, <em>sddc_id=None</em>, <em>draas_h5_url=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_client.</code><code class="sig-name descname">SiteRecovery</code><span class="sig-paren">(</span><em class="sig-param">updated=None</em>, <em class="sig-param">user_id=None</em>, <em class="sig-param">created=None</em>, <em class="sig-param">updated_by_user_id=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">updated_by_user_name=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">site_recovery_state=None</em>, <em class="sig-param">vr_node=None</em>, <em class="sig-param">srm_nodes=None</em>, <em class="sig-param">sddc_id=None</em>, <em class="sig-param">draas_h5_url=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="first admonition-title">Tip</p>
|
<p class="admonition-title">Tip</p>
|
||||||
<p class="last">The arguments are used to initialize data attributes with the same
|
<p>The arguments are used to initialize data attributes with the same
|
||||||
names.</p>
|
names.</p>
|
||||||
</div>
|
</div>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
<li><p><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</p></li>
|
||||||
<li><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
<li><p><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </p></li>
|
||||||
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
<li><p><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</p></li>
|
||||||
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</p></li>
|
||||||
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
<li><p><strong>updated_by_user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</p></li>
|
||||||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
|
<li><p><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</p></li>
|
||||||
<li><strong>updated_by_user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||||
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
<li><p><strong>site_recovery_state</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>) – <p>Possible values are:</p>
|
||||||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
|
||||||
<li><strong>site_recovery_state</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>) – <p>Possible values are:</p>
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_FAILED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_FAILED</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_FAILED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_FAILED</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_CANCELED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_CANCELED</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_CANCELED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_CANCELED</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DELETED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_DELETED</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DELETED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_DELETED</span></code></a></p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</p></li>
|
||||||
<li><strong>vr_node</strong> (<a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode"><code class="xref py py-class docutils literal notranslate"><span class="pre">SiteRecoveryNode</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>vr_node</strong> (<a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode"><code class="xref py py-class docutils literal notranslate"><span class="pre">SiteRecoveryNode</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>srm_nodes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode"><code class="xref py py-class docutils literal notranslate"><span class="pre">SiteRecoveryNode</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>srm_nodes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode"><code class="xref py py-class docutils literal notranslate"><span class="pre">SiteRecoveryNode</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>draas_h5_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>draas_h5_url</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>) – </p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED">
|
||||||
<code class="descname">SITE_RECOVERY_STATE_ACTIVATED</code><em class="property"> = 'ACTIVATED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">SITE_RECOVERY_STATE_ACTIVATED</code><em class="property"> = 'ACTIVATED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING">
|
||||||
<code class="descname">SITE_RECOVERY_STATE_ACTIVATING</code><em class="property"> = 'ACTIVATING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">SITE_RECOVERY_STATE_ACTIVATING</code><em class="property"> = 'ACTIVATING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_CANCELED">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_CANCELED">
|
||||||
<code class="descname">SITE_RECOVERY_STATE_CANCELED</code><em class="property"> = 'CANCELED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_CANCELED" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">SITE_RECOVERY_STATE_CANCELED</code><em class="property"> = 'CANCELED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_CANCELED" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED">
|
||||||
<code class="descname">SITE_RECOVERY_STATE_DEACTIVATED</code><em class="property"> = 'DEACTIVATED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">SITE_RECOVERY_STATE_DEACTIVATED</code><em class="property"> = 'DEACTIVATED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING">
|
||||||
<code class="descname">SITE_RECOVERY_STATE_DEACTIVATING</code><em class="property"> = 'DEACTIVATING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">SITE_RECOVERY_STATE_DEACTIVATING</code><em class="property"> = 'DEACTIVATING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DELETED">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DELETED">
|
||||||
<code class="descname">SITE_RECOVERY_STATE_DELETED</code><em class="property"> = 'DELETED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DELETED" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">SITE_RECOVERY_STATE_DELETED</code><em class="property"> = 'DELETED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DELETED" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_FAILED">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_FAILED">
|
||||||
<code class="descname">SITE_RECOVERY_STATE_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_FAILED" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">SITE_RECOVERY_STATE_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_FAILED" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">SiteRecoveryNode</code><span class="sig-paren">(</span><em>vm_moref_id=None</em>, <em>ip_address=None</em>, <em>hostname=None</em>, <em>id=None</em>, <em>state=None</em>, <em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_client.</code><code class="sig-name descname">SiteRecoveryNode</code><span class="sig-paren">(</span><em class="sig-param">vm_moref_id=None</em>, <em class="sig-param">ip_address=None</em>, <em class="sig-param">hostname=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="first admonition-title">Tip</p>
|
<p class="admonition-title">Tip</p>
|
||||||
<p class="last">The arguments are used to initialize data attributes with the same
|
<p>The arguments are used to initialize data attributes with the same
|
||||||
names.</p>
|
names.</p>
|
||||||
</div>
|
</div>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>vm_moref_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
<li><p><strong>ip_address</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>) – </p></li>
|
||||||
<li><strong>vm_moref_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>hostname</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>) – </p></li>
|
||||||
<li><strong>ip_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>state</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>) – <p>Possible values are:</p>
|
||||||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
|
||||||
<li><strong>state</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>) – <p>Possible values are:</p>
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DEPLOYING" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DEPLOYING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_DEPLOYING</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DEPLOYING" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DEPLOYING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_DEPLOYING</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_PROVISIONED" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_PROVISIONED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_PROVISIONED</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_PROVISIONED" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_PROVISIONED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_PROVISIONED</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_READY" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_READY</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_READY" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_READY</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DELETING" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DELETING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_DELETING</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DELETING" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DELETING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_DELETING</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_FAILED" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_FAILED</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_FAILED" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_FAILED</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_CANCELED" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_CANCELED</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_CANCELED" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_CANCELED</span></code></a></p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</p></li>
|
||||||
<li><strong>type</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>) – <p>Possible values are:</p>
|
<li><p><strong>type</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>) – <p>Possible values are:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRMS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRMS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.TYPE_VRMS</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRMS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRMS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.TYPE_VRMS</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_SRM" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_SRM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.TYPE_SRM</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_SRM" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_SRM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.TYPE_SRM</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.TYPE_VRS</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.TYPE_VRS</span></code></a></p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_CANCELED">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_CANCELED">
|
||||||
<code class="descname">STATE_CANCELED</code><em class="property"> = 'CANCELED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_CANCELED" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">STATE_CANCELED</code><em class="property"> = 'CANCELED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_CANCELED" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DELETING">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DELETING">
|
||||||
<code class="descname">STATE_DELETING</code><em class="property"> = 'DELETING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DELETING" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">STATE_DELETING</code><em class="property"> = 'DELETING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DELETING" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DEPLOYING">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DEPLOYING">
|
||||||
<code class="descname">STATE_DEPLOYING</code><em class="property"> = 'DEPLOYING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DEPLOYING" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">STATE_DEPLOYING</code><em class="property"> = 'DEPLOYING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DEPLOYING" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_FAILED">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_FAILED">
|
||||||
<code class="descname">STATE_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_FAILED" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">STATE_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_FAILED" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_PROVISIONED">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_PROVISIONED">
|
||||||
<code class="descname">STATE_PROVISIONED</code><em class="property"> = 'PROVISIONED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_PROVISIONED" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">STATE_PROVISIONED</code><em class="property"> = 'PROVISIONED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_PROVISIONED" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_READY">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_READY">
|
||||||
<code class="descname">STATE_READY</code><em class="property"> = 'READY'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_READY" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">STATE_READY</code><em class="property"> = 'READY'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_READY" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_SRM">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_SRM">
|
||||||
<code class="descname">TYPE_SRM</code><em class="property"> = 'SRM'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_SRM" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">TYPE_SRM</code><em class="property"> = 'SRM'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_SRM" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRMS">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRMS">
|
||||||
<code class="descname">TYPE_VRMS</code><em class="property"> = 'VRMS'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRMS" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">TYPE_VRMS</code><em class="property"> = 'VRMS'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRMS" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRS">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRS">
|
||||||
<code class="descname">TYPE_VRS</code><em class="property"> = 'VRS'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRS" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">TYPE_VRS</code><em class="property"> = 'VRS'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRS" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">SiteRecoveryNodeVersion</code><span class="sig-paren">(</span><em>version_source=None</em>, <em>node_id=None</em>, <em>build_number=None</em>, <em>appliance_version=None</em>, <em>node_ip=None</em>, <em>full_version=None</em>, <em>node_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_client.</code><code class="sig-name descname">SiteRecoveryNodeVersion</code><span class="sig-paren">(</span><em class="sig-param">version_source=None</em>, <em class="sig-param">node_id=None</em>, <em class="sig-param">build_number=None</em>, <em class="sig-param">appliance_version=None</em>, <em class="sig-param">node_ip=None</em>, <em class="sig-param">full_version=None</em>, <em class="sig-param">node_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="first admonition-title">Tip</p>
|
<p class="admonition-title">Tip</p>
|
||||||
<p class="last">The arguments are used to initialize data attributes with the same
|
<p>The arguments are used to initialize data attributes with the same
|
||||||
names.</p>
|
names.</p>
|
||||||
</div>
|
</div>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>version_source</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>) – <p>Possible values are:</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
||||||
<li><strong>version_source</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>) – <p>Possible values are:</p>
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_LS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_LS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.VERSION_SOURCE_LS</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_LS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_LS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.VERSION_SOURCE_LS</span></code></a></p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</p></li>
|
||||||
<li><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>build_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>build_number</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>) – </p></li>
|
||||||
<li><strong>appliance_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>appliance_version</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>) – </p></li>
|
||||||
<li><strong>node_ip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>node_ip</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>) – </p></li>
|
||||||
<li><strong>full_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>full_version</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>) – </p></li>
|
||||||
<li><strong>node_type</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>) – <p>Possible values are:</p>
|
<li><p><strong>node_type</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>) – <p>Possible values are:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRMS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRMS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.NODE_TYPE_VRMS</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRMS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRMS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.NODE_TYPE_VRMS</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_SRM" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_SRM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.NODE_TYPE_SRM</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_SRM" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_SRM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.NODE_TYPE_SRM</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.NODE_TYPE_VRS</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.NODE_TYPE_VRS</span></code></a></p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_SRM">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_SRM">
|
||||||
<code class="descname">NODE_TYPE_SRM</code><em class="property"> = 'SRM'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_SRM" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">NODE_TYPE_SRM</code><em class="property"> = 'SRM'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_SRM" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRMS">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRMS">
|
||||||
<code class="descname">NODE_TYPE_VRMS</code><em class="property"> = 'VRMS'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRMS" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">NODE_TYPE_VRMS</code><em class="property"> = 'VRMS'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRMS" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRS">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRS">
|
||||||
<code class="descname">NODE_TYPE_VRS</code><em class="property"> = 'VRS'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRS" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">NODE_TYPE_VRS</code><em class="property"> = 'VRS'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRS" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_LS">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_LS">
|
||||||
<code class="descname">VERSION_SOURCE_LS</code><em class="property"> = 'ls'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_LS" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">VERSION_SOURCE_LS</code><em class="property"> = 'ls'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_LS" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI">
|
||||||
<code class="descname">VERSION_SOURCE_VAMICLI</code><em class="property"> = 'vamicli'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">VERSION_SOURCE_VAMICLI</code><em class="property"> = 'vamicli'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryVersions">
|
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryVersions">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">SiteRecoveryVersions</code><span class="sig-paren">(</span><em>generated=None</em>, <em>sddc_id=None</em>, <em>node_versions=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryVersions" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_client.</code><code class="sig-name descname">SiteRecoveryVersions</code><span class="sig-paren">(</span><em class="sig-param">generated=None</em>, <em class="sig-param">sddc_id=None</em>, <em class="sig-param">node_versions=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryVersions" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="first admonition-title">Tip</p>
|
<p class="admonition-title">Tip</p>
|
||||||
<p class="last">The arguments are used to initialize data attributes with the same
|
<p>The arguments are used to initialize data attributes with the same
|
||||||
names.</p>
|
names.</p>
|
||||||
</div>
|
</div>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>generated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>generated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>node_versions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion"><code class="xref py py-class docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – list of site recovery node version</p></li>
|
||||||
<li><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
|
||||||
<li><strong>node_versions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion"><code class="xref py py-class docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – list of site recovery node version</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.StubFactory">
|
<dt id="com.vmware.vmc.draas.model_client.StubFactory">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_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.draas.model_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_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.draas.model_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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<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>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.Task">
|
<dt id="com.vmware.vmc.draas.model_client.Task">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">Task</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>created=None</em>, <em>updated_by_user_id=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em>, <em>status=None</em>, <em>resource_id=None</em>, <em>start_time=None</em>, <em>retries=None</em>, <em>task_type=None</em>, <em>task_progress_phases=None</em>, <em>tenant_id=None</em>, <em>error_message=None</em>, <em>parent_task_id=None</em>, <em>progress_percent=None</em>, <em>estimated_remaining_minutes=None</em>, <em>params=None</em>, <em>end_time=None</em>, <em>task_version=None</em>, <em>resource_type=None</em>, <em>sub_status=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_client.</code><code class="sig-name descname">Task</code><span class="sig-paren">(</span><em class="sig-param">updated=None</em>, <em class="sig-param">user_id=None</em>, <em class="sig-param">created=None</em>, <em class="sig-param">updated_by_user_id=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">updated_by_user_name=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">resource_id=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">retries=None</em>, <em class="sig-param">task_type=None</em>, <em class="sig-param">task_progress_phases=None</em>, <em class="sig-param">tenant_id=None</em>, <em class="sig-param">error_message=None</em>, <em class="sig-param">parent_task_id=None</em>, <em class="sig-param">progress_percent=None</em>, <em class="sig-param">estimated_remaining_minutes=None</em>, <em class="sig-param">params=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">task_version=None</em>, <em class="sig-param">resource_type=None</em>, <em class="sig-param">sub_status=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="first admonition-title">Tip</p>
|
<p class="admonition-title">Tip</p>
|
||||||
<p class="last">The arguments are used to initialize data attributes with the same
|
<p>The arguments are used to initialize data attributes with the same
|
||||||
names.</p>
|
names.</p>
|
||||||
</div>
|
</div>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
<li><p><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</p></li>
|
||||||
<li><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
<li><p><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </p></li>
|
||||||
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
<li><p><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</p></li>
|
||||||
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</p></li>
|
||||||
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
<li><p><strong>updated_by_user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</p></li>
|
||||||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
|
<li><p><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</p></li>
|
||||||
<li><strong>updated_by_user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||||
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
<li><p><strong>status</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>) – <p>Possible values are:</p>
|
||||||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
|
||||||
<li><strong>status</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>) – <p>Possible values are:</p>
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_STARTED" title="com.vmware.vmc.draas.model_client.Task.STATUS_STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_STARTED</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_STARTED" title="com.vmware.vmc.draas.model_client.Task.STATUS_STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_STARTED</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_CANCELING" title="com.vmware.vmc.draas.model_client.Task.STATUS_CANCELING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_CANCELING</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_CANCELING" title="com.vmware.vmc.draas.model_client.Task.STATUS_CANCELING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_CANCELING</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_FINISHED" title="com.vmware.vmc.draas.model_client.Task.STATUS_FINISHED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_FINISHED</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_FINISHED" title="com.vmware.vmc.draas.model_client.Task.STATUS_FINISHED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_FINISHED</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_FAILED" title="com.vmware.vmc.draas.model_client.Task.STATUS_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_FAILED</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_FAILED" title="com.vmware.vmc.draas.model_client.Task.STATUS_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_FAILED</span></code></a></p></li>
|
||||||
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_CANCELED" title="com.vmware.vmc.draas.model_client.Task.STATUS_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_CANCELED</span></code></a></li>
|
<li><p><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_CANCELED" title="com.vmware.vmc.draas.model_client.Task.STATUS_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_CANCELED</span></code></a></p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</p></li>
|
||||||
<li><strong>resource_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – UUID of resources task is acting upon</li>
|
<li><p><strong>resource_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – UUID of resources task is acting upon</p></li>
|
||||||
<li><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>start_time</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>) – </p></li>
|
||||||
<li><strong>retries</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>) – </li>
|
<li><p><strong>retries</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>) – </p></li>
|
||||||
<li><strong>task_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>task_type</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>) – </p></li>
|
||||||
<li><strong>task_progress_phases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.draas.model_client.TaskProgressPhase" title="com.vmware.vmc.draas.model_client.TaskProgressPhase"><code class="xref py py-class docutils literal notranslate"><span class="pre">TaskProgressPhase</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Task progress phases involved in current task execution</li>
|
<li><p><strong>task_progress_phases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.draas.model_client.TaskProgressPhase" title="com.vmware.vmc.draas.model_client.TaskProgressPhase"><code class="xref py py-class docutils literal notranslate"><span class="pre">TaskProgressPhase</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Task progress phases involved in current task execution</p></li>
|
||||||
<li><strong>tenant_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>tenant_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>error_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>error_message</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>) – </p></li>
|
||||||
<li><strong>parent_task_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>parent_task_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>progress_percent</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>) – Estimated progress percentage the task executed format: int32</li>
|
<li><p><strong>progress_percent</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>) – Estimated progress percentage the task executed format: int32</p></li>
|
||||||
<li><strong>estimated_remaining_minutes</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>) – Estimated remaining time in minute of the task execution, < 0 means
|
<li><p><strong>estimated_remaining_minutes</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>) – Estimated remaining time in minute of the task execution, < 0 means
|
||||||
no estimation for the task. format: int32</li>
|
no estimation for the task. format: int32</p></li>
|
||||||
<li><strong>params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
|
||||||
<li><strong>task_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>task_version</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>) – </p></li>
|
||||||
<li><strong>resource_type</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>) – Type of resource being acted upon</li>
|
<li><p><strong>resource_type</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>) – Type of resource being acted upon</p></li>
|
||||||
<li><strong>sub_status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
<li><p><strong>sub_status</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>) – </p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_CANCELED">
|
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_CANCELED">
|
||||||
<code class="descname">STATUS_CANCELED</code><em class="property"> = 'CANCELED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_CANCELED" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">STATUS_CANCELED</code><em class="property"> = 'CANCELED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_CANCELED" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_CANCELING">
|
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_CANCELING">
|
||||||
<code class="descname">STATUS_CANCELING</code><em class="property"> = 'CANCELING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_CANCELING" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">STATUS_CANCELING</code><em class="property"> = 'CANCELING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_CANCELING" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_FAILED">
|
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_FAILED">
|
||||||
<code class="descname">STATUS_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_FAILED" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">STATUS_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_FAILED" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_FINISHED">
|
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_FINISHED">
|
||||||
<code class="descname">STATUS_FINISHED</code><em class="property"> = 'FINISHED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_FINISHED" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">STATUS_FINISHED</code><em class="property"> = 'FINISHED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_FINISHED" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_STARTED">
|
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_STARTED">
|
||||||
<code class="descname">STATUS_STARTED</code><em class="property"> = 'STARTED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_STARTED" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">STATUS_STARTED</code><em class="property"> = 'STARTED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_STARTED" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas.model_client.TaskProgressPhase">
|
<dt id="com.vmware.vmc.draas.model_client.TaskProgressPhase">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">TaskProgressPhase</code><span class="sig-paren">(</span><em>id=None</em>, <em>name=None</em>, <em>progress_percent=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.TaskProgressPhase" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas.model_client.</code><code class="sig-name descname">TaskProgressPhase</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">progress_percent=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.TaskProgressPhase" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||||
<p>A task progress can be (but does NOT have to be) divided to more meaningful
|
<p>A task progress can be (but does NOT have to be) divided to more meaningful
|
||||||
progress phases.</p>
|
progress phases.</p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="first admonition-title">Tip</p>
|
<p class="admonition-title">Tip</p>
|
||||||
<p class="last">The arguments are used to initialize data attributes with the same
|
<p>The arguments are used to initialize data attributes with the same
|
||||||
names.</p>
|
names.</p>
|
||||||
</div>
|
</div>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the task progress phase</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The display name of the task progress phase</p></li>
|
||||||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the task progress phase</li>
|
<li><p><strong>progress_percent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The percentage of the phase that has completed format: int32</p></li>
|
||||||
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The display name of the task progress phase</li>
|
|
||||||
<li><strong>progress_percent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The percentage of the phase that has completed format: int32</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -729,10 +679,11 @@ names.</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2019, VMware, Inc. All rights reserved
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
</footer>
|
</footer>
|
||||||
|
|
||||||
|
|||||||
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.vmc package — vSphere Automation SDK for Python 1.9.0 documentation</title>
|
<title>com.vmware.vmc package — draas 1.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -50,7 +50,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
<a href="index.html" class="icon icon-home"> draas
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -60,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
1.9.0
|
1.1.0
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -111,7 +111,7 @@
|
|||||||
<nav class="wy-nav-top" aria-label="top navigation">
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
<a href="index.html">vSphere Automation SDK for Python</a>
|
<a href="index.html">draas</a>
|
||||||
|
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
@ -186,456 +186,441 @@
|
|||||||
<span id="com-vmware-vmc-draas-client-module"></span><h2>com.vmware.vmc.draas_client module<a class="headerlink" href="#module-com.vmware.vmc.draas_client" title="Permalink to this headline">¶</a></h2>
|
<span id="com-vmware-vmc-draas-client-module"></span><h2>com.vmware.vmc.draas_client module<a class="headerlink" href="#module-com.vmware.vmc.draas_client" title="Permalink to this headline">¶</a></h2>
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas_client.ReplicaDiskCollections">
|
<dt id="com.vmware.vmc.draas_client.ReplicaDiskCollections">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas_client.</code><code class="descname">ReplicaDiskCollections</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.ReplicaDiskCollections" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas_client.</code><code class="sig-name descname">ReplicaDiskCollections</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.ReplicaDiskCollections" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<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">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<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>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.vmc.draas_client.ReplicaDiskCollections.get">
|
<dt id="com.vmware.vmc.draas_client.ReplicaDiskCollections.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>datastore_mo_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.ReplicaDiskCollections.get" title="Permalink to this definition">¶</a></dt>
|
<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">datastore_mo_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.ReplicaDiskCollections.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Query replica disk collections</p>
|
<dd><p>Query replica disk collections</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<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>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<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><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</li>
|
<li><p><strong>datastore_mo_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Represents the datastore moref id to search. (optional)</p></li>
|
||||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – sddc identifier (required)</li>
|
|
||||||
<li><strong>datastore_mo_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Represents the datastore moref id to search. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.ReplicaDiskCollection" title="com.vmware.vmc.draas.model_client.ReplicaDiskCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.ReplicaDiskCollection</span></code></a></p>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.ReplicaDiskCollection" title="com.vmware.vmc.draas.model_client.ReplicaDiskCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.ReplicaDiskCollection</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p>
|
<dd class="field-odd"><p></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
<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>
|
Unauthorized</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<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 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>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<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 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</p>
|
Not found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas_client.SiteRecovery">
|
<dt id="com.vmware.vmc.draas_client.SiteRecovery">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas_client.</code><code class="descname">SiteRecovery</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecovery" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas_client.</code><code class="sig-name descname">SiteRecovery</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecovery" 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>
|
<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">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<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>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.vmc.draas_client.SiteRecovery.delete">
|
<dt id="com.vmware.vmc.draas_client.SiteRecovery.delete">
|
||||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>force=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecovery.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">force=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecovery.delete" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Deactivate site recovery for the specified sddc</p>
|
<dd><p>Deactivate site recovery for the specified sddc</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<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>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<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><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</li>
|
<li><p><strong>force</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’, will deactivate site recovery forcefully. (optional)</p></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>force</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’, will deactivate site recovery forcefully. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.draas.model.Task</p>
|
<dd class="field-odd"><p>com.vmware.vmc.draas.model.Task</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
<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>
|
Unauthorized</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<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.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Invalid action or bad argument</p>
|
Invalid action or bad argument</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<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.Unauthorized</span></code>
|
<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>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd 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 class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Cannot find site recovery configuration for sddc identifier</p>
|
Cannot find site recovery configuration for sddc identifier</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.vmc.draas_client.SiteRecovery.get">
|
<dt id="com.vmware.vmc.draas_client.SiteRecovery.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecovery.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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecovery.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Query site recovery configuration for the specified sddc</p>
|
<dd><p>Query site recovery configuration for the specified sddc</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<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>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<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><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>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.SiteRecovery" title="com.vmware.vmc.draas.model_client.SiteRecovery"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.SiteRecovery</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.SiteRecovery" title="com.vmware.vmc.draas.model_client.SiteRecovery"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.SiteRecovery</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.draas.model.SiteRecovery</p>
|
<dd class="field-odd"><p>com.vmware.vmc.draas.model.SiteRecovery</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
<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>
|
Unauthorized</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<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.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Invalid action or bad argument</p>
|
Invalid action or bad argument</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<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.Unauthorized</span></code>
|
<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>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.vmc.draas_client.SiteRecovery.post">
|
<dt id="com.vmware.vmc.draas_client.SiteRecovery.post">
|
||||||
<code class="descname">post</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>activate_site_recovery_config=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecovery.post" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">post</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">site_recovery_node</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecovery.post" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Activate site recovery for the specified sddc</p>
|
<dd><p>Create audit setup task for specific appliance and configure rsyslog
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
for it.</p>
|
||||||
<col class="field-name" />
|
<dl class="field-list simple">
|
||||||
<col class="field-body" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<tbody valign="top">
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first 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><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</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><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – sddc identifier (required)</li>
|
<li><p><strong>site_recovery_node</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Site recovery node identifier (required)</p></li>
|
||||||
<li><strong>activate_site_recovery_config</strong> (<a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig" title="com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Customization, for example can specify custom extension key suffix
|
|
||||||
for SRM. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.draas.model.Task</p>
|
<dd class="field-odd"><p>com.vmware.vmc.draas.model.Task</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
<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>
|
Unauthorized</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<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.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Invalid action or bad argument</p>
|
Invalid action or bad argument</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<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.Unauthorized</span></code>
|
<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>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd 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 class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Cannot find site recovery configuration for sddc identifier</p>
|
Cannot find site recovery for the given sddc or site recovery node
|
||||||
</td>
|
for the given node id.</p>
|
||||||
</tr>
|
</dd>
|
||||||
</tbody>
|
</dl>
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.vmc.draas_client.SiteRecovery.post_0">
|
<dt id="com.vmware.vmc.draas_client.SiteRecovery.post_0">
|
||||||
<code class="descname">post_0</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>site_recovery_node</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecovery.post_0" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">post_0</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">activate_site_recovery_config=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecovery.post_0" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Upload backup script to specific appliance.</p>
|
<dd><p>Activate site recovery for the specified sddc</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<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>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<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><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</li>
|
<li><p><strong>activate_site_recovery_config</strong> (<a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig" title="com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Customization, for example can specify custom extension key suffix
|
||||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – sddc identifier (required)</li>
|
for SRM. (optional)</p></li>
|
||||||
<li><strong>site_recovery_node</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Site recovery node identifier (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.draas.model.Task</p>
|
<dd class="field-odd"><p>com.vmware.vmc.draas.model.Task</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
<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>
|
Unauthorized</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<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.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Invalid action or bad argument</p>
|
Invalid action or bad argument</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<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.Unauthorized</span></code>
|
<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>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd 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 class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Cannot find site recovery configuration for sddc identifier</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="method">
|
||||||
|
<dt id="com.vmware.vmc.draas_client.SiteRecovery.post_1">
|
||||||
|
<code class="sig-name descname">post_1</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">site_recovery_node</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecovery.post_1" title="Permalink to this definition">¶</a></dt>
|
||||||
|
<dd><p>Upload backup script to specific appliance.</p>
|
||||||
|
<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>site_recovery_node</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Site recovery node identifier (required)</p></li>
|
||||||
|
</ul>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-even">Return type</dt>
|
||||||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-odd">Returns</dt>
|
||||||
|
<dd class="field-odd"><p>com.vmware.vmc.draas.model.Task</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.InvalidRequest</span></code>
|
||||||
|
Invalid action or bad argument</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>
|
||||||
|
<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.NotFound</span></code>
|
||||||
Cannot find site recovery script file</p>
|
Cannot find site recovery script file</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas_client.SiteRecoverySrmNodes">
|
<dt id="com.vmware.vmc.draas_client.SiteRecoverySrmNodes">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas_client.</code><code class="descname">SiteRecoverySrmNodes</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoverySrmNodes" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas_client.</code><code class="sig-name descname">SiteRecoverySrmNodes</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoverySrmNodes" 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>
|
<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">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<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>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.vmc.draas_client.SiteRecoverySrmNodes.delete">
|
<dt id="com.vmware.vmc.draas_client.SiteRecoverySrmNodes.delete">
|
||||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>srm_node</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoverySrmNodes.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">srm_node</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoverySrmNodes.delete" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Delete a SRM server.</p>
|
<dd><p>Delete a SRM server.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<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>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<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><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</li>
|
<li><p><strong>srm_node</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SRM node identifier (required)</p></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>srm_node</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SRM node identifier (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.draas.model.Task</p>
|
<dd class="field-odd"><p>com.vmware.vmc.draas.model.Task</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
<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>
|
Unauthorized</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<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.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Invalid action or bad argument</p>
|
Invalid action or bad argument</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<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.Unauthorized</span></code>
|
<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>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd 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 class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Cannot find SDDC or SRM node</p>
|
Cannot find SDDC or SRM node</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.vmc.draas_client.SiteRecoverySrmNodes.post">
|
<dt id="com.vmware.vmc.draas_client.SiteRecoverySrmNodes.post">
|
||||||
<code class="descname">post</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>provision_srm_config=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoverySrmNodes.post" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">post</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">provision_srm_config=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoverySrmNodes.post" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Provision an additional SRM server.</p>
|
<dd><p>Provision an additional SRM server.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<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>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<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><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</li>
|
<li><p><strong>provision_srm_config</strong> (<a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.ProvisionSrmConfig" title="com.vmware.vmc.draas.model_client.ProvisionSrmConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.ProvisionSrmConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Customization, for example can specify custom extension key suffix
|
||||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – sddc identifier (required)</li>
|
for SRM. (optional)</p></li>
|
||||||
<li><strong>provision_srm_config</strong> (<a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.ProvisionSrmConfig" title="com.vmware.vmc.draas.model_client.ProvisionSrmConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.ProvisionSrmConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Customization, for example can specify custom extension key suffix
|
|
||||||
for SRM. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.draas.model.Task</p>
|
<dd class="field-odd"><p>com.vmware.vmc.draas.model.Task</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
<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>
|
Unauthorized</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<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.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Invalid action or bad argument</p>
|
Invalid action or bad argument</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<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.Unauthorized</span></code>
|
<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>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd 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 class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Cannot find site recovery configuration for sddc identifier</p>
|
Cannot find site recovery configuration for sddc identifier</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas_client.SiteRecoveryVersions">
|
<dt id="com.vmware.vmc.draas_client.SiteRecoveryVersions">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas_client.</code><code class="descname">SiteRecoveryVersions</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoveryVersions" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas_client.</code><code class="sig-name descname">SiteRecoveryVersions</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoveryVersions" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<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">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<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>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas_client.SiteRecoveryVersions.GET_VERSION_SOURCE_LS">
|
<dt id="com.vmware.vmc.draas_client.SiteRecoveryVersions.GET_VERSION_SOURCE_LS">
|
||||||
<code class="descname">GET_VERSION_SOURCE_LS</code><em class="property"> = 'ls'</em><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoveryVersions.GET_VERSION_SOURCE_LS" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">GET_VERSION_SOURCE_LS</code><em class="property"> = 'ls'</em><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoveryVersions.GET_VERSION_SOURCE_LS" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">versionSource</span></code> of method
|
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">versionSource</span></code> of method
|
||||||
<a class="reference internal" href="#com.vmware.vmc.draas_client.SiteRecoveryVersions.get" title="com.vmware.vmc.draas_client.SiteRecoveryVersions.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">SiteRecoveryVersions.get()</span></code></a>.</p>
|
<a class="reference internal" href="#com.vmware.vmc.draas_client.SiteRecoveryVersions.get" title="com.vmware.vmc.draas_client.SiteRecoveryVersions.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">SiteRecoveryVersions.get()</span></code></a>.</p>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.vmc.draas_client.SiteRecoveryVersions.GET_VERSION_SOURCE_VAMICLI">
|
<dt id="com.vmware.vmc.draas_client.SiteRecoveryVersions.GET_VERSION_SOURCE_VAMICLI">
|
||||||
<code class="descname">GET_VERSION_SOURCE_VAMICLI</code><em class="property"> = 'vamicli'</em><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoveryVersions.GET_VERSION_SOURCE_VAMICLI" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">GET_VERSION_SOURCE_VAMICLI</code><em class="property"> = 'vamicli'</em><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoveryVersions.GET_VERSION_SOURCE_VAMICLI" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">versionSource</span></code> of method
|
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">versionSource</span></code> of method
|
||||||
<a class="reference internal" href="#com.vmware.vmc.draas_client.SiteRecoveryVersions.get" title="com.vmware.vmc.draas_client.SiteRecoveryVersions.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">SiteRecoveryVersions.get()</span></code></a>.</p>
|
<a class="reference internal" href="#com.vmware.vmc.draas_client.SiteRecoveryVersions.get" title="com.vmware.vmc.draas_client.SiteRecoveryVersions.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">SiteRecoveryVersions.get()</span></code></a>.</p>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.vmc.draas_client.SiteRecoveryVersions.get">
|
<dt id="com.vmware.vmc.draas_client.SiteRecoveryVersions.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>version_source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoveryVersions.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">version_source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.SiteRecoveryVersions.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Query site recovery versions for the specified sddc</p>
|
<dd><p>Query site recovery versions for the specified sddc</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<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>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<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><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</li>
|
<li><p><strong>version_source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Represents the source for getting the version from. (optional)</p></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>version_source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Represents the source for getting the version from. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.SiteRecoveryVersions" title="com.vmware.vmc.draas.model_client.SiteRecoveryVersions"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.SiteRecoveryVersions</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.SiteRecoveryVersions" title="com.vmware.vmc.draas.model_client.SiteRecoveryVersions"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.SiteRecoveryVersions</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.draas.model.SiteRecoveryVersions</p>
|
<dd class="field-odd"><p>com.vmware.vmc.draas.model.SiteRecoveryVersions</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
<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>
|
Unauthorized</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<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.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Invalid action or bad argument</p>
|
Invalid action or bad argument</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<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.Unauthorized</span></code>
|
<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>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd 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 class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Cannot find site recovery versions for sddc identifier</p>
|
Cannot find site recovery versions for sddc identifier</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas_client.StubFactory">
|
<dt id="com.vmware.vmc.draas_client.StubFactory">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas_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.draas_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas_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.draas_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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<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>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.vmc.draas_client.Task">
|
<dt id="com.vmware.vmc.draas_client.Task">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas_client.</code><code class="descname">Task</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.Task" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.draas_client.</code><code class="sig-name descname">Task</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.Task" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<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">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<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>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.vmc.draas_client.Task.get">
|
<dt id="com.vmware.vmc.draas_client.Task.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>task</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.Task.get" title="Permalink to this definition">¶</a></dt>
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">task</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.Task.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Retrieve details of a task.</p>
|
<dd><p>Retrieve details of a task.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<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>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – task identifier (required)</p></li>
|
||||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</li>
|
|
||||||
<li><strong>task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – task identifier (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.draas.model.Task</p>
|
<dd class="field-odd"><p>com.vmware.vmc.draas.model.Task</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
<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>
|
Unauthorized</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<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 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>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<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 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>
|
||||||
Cannot find the task with given identifier</p>
|
Cannot find the task with given identifier</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -663,10 +648,11 @@ Cannot find the task with given identifier</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2019, VMware, Inc. All rights reserved
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
</footer>
|
</footer>
|
||||||
|
|
||||||
|
|||||||
272
vmc-draas/enumeration.html
Normal file
272
vmc-draas/enumeration.html
Normal file
@ -0,0 +1,272 @@
|
|||||||
|
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||||
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
|
<title>Interface definition language to python mapping for enumerated types — draas 1.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="index.html" class="icon icon-home"> draas
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="version">
|
||||||
|
1.1.0
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="com.html">com package</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">draas</a>
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
|
||||||
|
<div class="rst-content">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
|
||||||
|
<li><a href="index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li>Interface definition language to python mapping for enumerated types</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
|
||||||
|
|
||||||
|
<a href="_sources/enumeration.rst.txt" rel="nofollow"> View page source</a>
|
||||||
|
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<div class="section" id="interface-definition-language-to-python-mapping-for-enumerated-types">
|
||||||
|
<span id="enumeration-description"></span><h1>Interface definition language to python mapping for enumerated types<a class="headerlink" href="#interface-definition-language-to-python-mapping-for-enumerated-types" title="Permalink to this headline">¶</a></h1>
|
||||||
|
<p>The interface language definition type system includes enumerated types. Python
|
||||||
|
SDK supports both 2.x and 3.x versions of Python. Since Python 2.x does
|
||||||
|
not have first class support for enumerations, special classes are
|
||||||
|
generated to represent enumerated types from the interface definition
|
||||||
|
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><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>
|
||||||
|
<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="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="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>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="code-examples">
|
||||||
|
<h2>Code Examples<a class="headerlink" href="#code-examples" title="Permalink to this headline">¶</a></h2>
|
||||||
|
<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><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>
|
||||||
|
|
||||||
|
<span class="c1"># SourceType has two class attrites, SourceType.FILE and SourceType.REMOTE</span>
|
||||||
|
<span class="n">spec</span> <span class="o">=</span> <span class="n">Source</span><span class="o">.</span><span class="n">CreateSpec</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">SourceType</span><span class="o">.</span><span class="n">FILE</span><span class="p">,</span> <span class="n">filepath</span><span class="o">=</span><span class="s1">'entity_metadata.json'</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s1">'Entity service'</span><span class="p">)</span>
|
||||||
|
<span class="n">source_svc</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="s1">'entity'</span><span class="p">,</span> <span class="n">spec</span><span class="o">=</span><span class="n">spec</span><span class="p">)</span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<ol class="arabic simple" start="2">
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<span class="n">source_info</span> <span class="o">=</span> <span class="n">source_svc</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="s1">'entity'</span><span class="p">)</span>
|
||||||
|
<span class="k">if</span> <span class="p">(</span><span class="n">source_info</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="n">SourceType</span><span class="o">.</span><span class="n">FILE</span><span class="p">)</span> <span class="p">{</span>
|
||||||
|
<span class="k">print</span> <span class="s1">'Source is a file'</span>
|
||||||
|
<span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="n">source_info</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="n">SourceType</span><span class="o">.</span><span class="n">REMOTE</span><span class="p">)</span> <span class="p">{</span>
|
||||||
|
<span class="k">print</span> <span class="s1">'Source is a remote provider'</span>
|
||||||
|
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
||||||
|
<span class="k">print</span> <span class="s1">'Unknown source type: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">source_info</span><span class="o">.</span><span class="n">type</span><span class="p">)</span>
|
||||||
|
<span class="p">}</span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<ol class="arabic simple" start="3">
|
||||||
|
<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>
|
||||||
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># If a newer version of SourceType has a new value FOLDER, FOLDER would be one</span>
|
||||||
|
<span class="c1"># of the class attributes for SourceType. In the older version, SourceType has</span>
|
||||||
|
<span class="c1"># only two class attributes, FILE and REMOTE</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>
|
||||||
|
<span class="n">spec</span> <span class="o">=</span> <span class="n">Source</span><span class="o">.</span><span class="n">CreateSpec</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">SourceType</span><span class="p">(</span><span class="s1">'FOLDER'</span><span class="p">),</span> <span class="n">filepath</span><span class="o">=</span><span class="s1">'entity_metadata'</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s1">'Entity service'</span><span class="p">)</span>
|
||||||
|
<span class="n">source_svc</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="s1">'entity'</span><span class="p">,</span> <span class="n">spec</span><span class="o">=</span><span class="n">spec</span><span class="p">)</span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<footer>
|
||||||
|
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>
|
||||||
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@ -9,7 +9,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>Index — vSphere Automation SDK for Python 1.9.0 documentation</title>
|
<title>Index — draas 1.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -49,7 +49,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
<a href="index.html" class="icon icon-home"> draas
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -59,7 +59,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
1.9.0
|
1.1.0
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -101,7 +101,7 @@
|
|||||||
<nav class="wy-nav-top" aria-label="top navigation">
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
<a href="index.html">vSphere Automation SDK for Python</a>
|
<a href="index.html">draas</a>
|
||||||
|
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
@ -186,16 +186,14 @@
|
|||||||
<li><a href="com.vmware.html#module-com.vmware">com.vmware (module)</a>
|
<li><a href="com.vmware.html#module-com.vmware">com.vmware (module)</a>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="com.vmware.vmc.html#module-com.vmware.vmc">com.vmware.vmc (module)</a>
|
<li><a href="com.vmware.vmc.html#module-com.vmware.vmc">com.vmware.vmc (module)</a>
|
||||||
</li>
|
|
||||||
<li><a href="com.vmware.vmc.draas.html#module-com.vmware.vmc.draas">com.vmware.vmc.draas (module)</a>
|
|
||||||
</li>
|
</li>
|
||||||
</ul></td>
|
</ul></td>
|
||||||
<td style="width: 33%; vertical-align: top;"><ul>
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="com.vmware.vmc.draas.html#module-com.vmware.vmc.draas">com.vmware.vmc.draas (module)</a>
|
||||||
|
</li>
|
||||||
<li><a href="com.vmware.vmc.draas.html#module-com.vmware.vmc.draas.model_client">com.vmware.vmc.draas.model_client (module)</a>
|
<li><a href="com.vmware.vmc.draas.html#module-com.vmware.vmc.draas.model_client">com.vmware.vmc.draas.model_client (module)</a>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="com.vmware.vmc.html#module-com.vmware.vmc.draas_client">com.vmware.vmc.draas_client (module)</a>
|
<li><a href="com.vmware.vmc.html#module-com.vmware.vmc.draas_client">com.vmware.vmc.draas_client (module)</a>
|
||||||
</li>
|
|
||||||
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.client.create_vmc_client">create_vmc_client() (in module vmware.vapi.vmc.client)</a>
|
|
||||||
</li>
|
</li>
|
||||||
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter">CSPSecurityContextFilter (class in vmware.vapi.vmc.csp_filter)</a>
|
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter">CSPSecurityContextFilter (class in vmware.vapi.vmc.csp_filter)</a>
|
||||||
</li>
|
</li>
|
||||||
@ -274,6 +272,8 @@
|
|||||||
</ul></td>
|
</ul></td>
|
||||||
<td style="width: 33%; vertical-align: top;"><ul>
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.SiteRecovery.post_0">post_0() (com.vmware.vmc.draas_client.SiteRecovery method)</a>
|
<li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.SiteRecovery.post_0">post_0() (com.vmware.vmc.draas_client.SiteRecovery method)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.SiteRecovery.post_1">post_1() (com.vmware.vmc.draas_client.SiteRecovery method)</a>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.ProvisionSrmConfig">ProvisionSrmConfig (class in com.vmware.vmc.draas.model_client)</a>
|
<li><a href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.ProvisionSrmConfig">ProvisionSrmConfig (class in com.vmware.vmc.draas.model_client)</a>
|
||||||
</li>
|
</li>
|
||||||
@ -393,19 +393,13 @@
|
|||||||
</li>
|
</li>
|
||||||
<li><a href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI">VERSION_SOURCE_VAMICLI (com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion attribute)</a>
|
<li><a href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI">VERSION_SOURCE_VAMICLI (com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion attribute)</a>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.client.VmcClient">VmcClient (class in vmware.vapi.vmc.client)</a>
|
<li><a href="vmware.html#module-vmware">vmware (module)</a>
|
||||||
</li>
|
|
||||||
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.client.VmcStubFactory">VmcStubFactory (class in vmware.vapi.vmc.client)</a>
|
|
||||||
</li>
|
</li>
|
||||||
</ul></td>
|
</ul></td>
|
||||||
<td style="width: 33%; vertical-align: top;"><ul>
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
<li><a href="vmware.html#module-vmware">vmware (module)</a>
|
|
||||||
</li>
|
|
||||||
<li><a href="vmware.vapi.html#module-vmware.vapi">vmware.vapi (module)</a>
|
<li><a href="vmware.vapi.html#module-vmware.vapi">vmware.vapi (module)</a>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc">vmware.vapi.vmc (module)</a>
|
<li><a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc">vmware.vapi.vmc (module)</a>
|
||||||
</li>
|
|
||||||
<li><a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.client">vmware.vapi.vmc.client (module)</a>
|
|
||||||
</li>
|
</li>
|
||||||
<li><a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter">vmware.vapi.vmc.csp_filter (module)</a>
|
<li><a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter">vmware.vapi.vmc.csp_filter (module)</a>
|
||||||
</li>
|
</li>
|
||||||
@ -424,10 +418,11 @@
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2019, VMware, Inc. All rights reserved
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
</footer>
|
</footer>
|
||||||
|
|
||||||
|
|||||||
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>Welcome to vAPI’s documentation! — vSphere Automation SDK for Python 1.9.0 documentation</title>
|
<title>Welcome to draas’s documentation! — draas 1.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -49,7 +49,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a href="#" class="icon icon-home"> vSphere Automation SDK for Python
|
<a href="#" class="icon icon-home"> draas
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -59,7 +59,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
1.9.0
|
1.1.0
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -101,7 +101,7 @@
|
|||||||
<nav class="wy-nav-top" aria-label="top navigation">
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
<a href="#">vSphere Automation SDK for Python</a>
|
<a href="#">draas</a>
|
||||||
|
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
@ -132,7 +132,7 @@
|
|||||||
|
|
||||||
<li><a href="#">Docs</a> »</li>
|
<li><a href="#">Docs</a> »</li>
|
||||||
|
|
||||||
<li>Welcome to vAPI’s documentation!</li>
|
<li>Welcome to draas’s documentation!</li>
|
||||||
|
|
||||||
|
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
@ -151,8 +151,8 @@
|
|||||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
<div itemprop="articleBody">
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
<div class="section" id="welcome-to-vapi-s-documentation">
|
<div class="section" id="welcome-to-draas-s-documentation">
|
||||||
<h1>Welcome to vAPI’s documentation!<a class="headerlink" href="#welcome-to-vapi-s-documentation" title="Permalink to this headline">¶</a></h1>
|
<h1>Welcome to draas’s documentation!<a class="headerlink" href="#welcome-to-draas-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||||||
<div class="toctree-wrapper compound">
|
<div class="toctree-wrapper compound">
|
||||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||||
<ul>
|
<ul>
|
||||||
@ -187,7 +187,7 @@
|
|||||||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.html#subpackages">Subpackages</a><ul>
|
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.html#subpackages">Subpackages</a><ul>
|
||||||
<li class="toctree-l5"><a class="reference internal" href="vmware.vapi.vmc.html">vmware.vapi.vmc package</a><ul>
|
<li class="toctree-l5"><a class="reference internal" href="vmware.vapi.vmc.html">vmware.vapi.vmc package</a><ul>
|
||||||
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.vmc.html#submodules">Submodules</a></li>
|
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.vmc.html#submodules">Submodules</a></li>
|
||||||
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.client">vmware.vapi.vmc.client module</a></li>
|
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.vmc.html#vmware-vapi-vmc-client-module">vmware.vapi.vmc.client module</a></li>
|
||||||
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter">vmware.vapi.vmc.csp_filter module</a></li>
|
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter">vmware.vapi.vmc.csp_filter module</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
@ -205,9 +205,9 @@
|
|||||||
<div class="section" id="indices-and-tables">
|
<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>
|
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
|
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
||||||
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
|
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></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="search.html"><span class="std std-ref">Search Page</span></a></p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -229,10 +229,11 @@
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2019, VMware, Inc. All rights reserved
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
</footer>
|
</footer>
|
||||||
|
|
||||||
|
|||||||
Binary file not shown.
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>Python Module Index — vSphere Automation SDK for Python 1.9.0 documentation</title>
|
<title>Python Module Index — draas 1.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -51,7 +51,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
<a href="index.html" class="icon icon-home"> draas
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -61,7 +61,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
1.9.0
|
1.1.0
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -103,7 +103,7 @@
|
|||||||
<nav class="wy-nav-top" aria-label="top navigation">
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
<a href="index.html">vSphere Automation SDK for Python</a>
|
<a href="index.html">draas</a>
|
||||||
|
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
@ -211,11 +211,6 @@
|
|||||||
<td>   
|
<td>   
|
||||||
<a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc"><code class="xref">vmware.vapi.vmc</code></a></td><td>
|
<a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc"><code class="xref">vmware.vapi.vmc</code></a></td><td>
|
||||||
<em></em></td></tr>
|
<em></em></td></tr>
|
||||||
<tr class="cg-2">
|
|
||||||
<td></td>
|
|
||||||
<td>   
|
|
||||||
<a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.client"><code class="xref">vmware.vapi.vmc.client</code></a></td><td>
|
|
||||||
<em></em></td></tr>
|
|
||||||
<tr class="cg-2">
|
<tr class="cg-2">
|
||||||
<td></td>
|
<td></td>
|
||||||
<td>   
|
<td>   
|
||||||
@ -234,10 +229,11 @@
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2019, VMware, Inc. All rights reserved
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
</footer>
|
</footer>
|
||||||
|
|
||||||
|
|||||||
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>Search — vSphere Automation SDK for Python 1.9.0 documentation</title>
|
<title>Search — draas 1.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -49,7 +49,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
<a href="index.html" class="icon icon-home"> draas
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -59,7 +59,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
1.9.0
|
1.1.0
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -101,7 +101,7 @@
|
|||||||
<nav class="wy-nav-top" aria-label="top navigation">
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
<a href="index.html">vSphere Automation SDK for Python</a>
|
<a href="index.html">draas</a>
|
||||||
|
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
@ -173,10 +173,11 @@
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2019, VMware, Inc. All rights reserved
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
</footer>
|
</footer>
|
||||||
|
|
||||||
|
|||||||
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">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>vmware package — vSphere Automation SDK for Python 1.9.0 documentation</title>
|
<title>vmware package — draas 1.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -50,7 +50,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
<a href="index.html" class="icon icon-home"> draas
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -60,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
1.9.0
|
1.1.0
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -108,7 +108,7 @@
|
|||||||
<nav class="wy-nav-top" aria-label="top navigation">
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
<a href="index.html">vSphere Automation SDK for Python</a>
|
<a href="index.html">draas</a>
|
||||||
|
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
@ -168,7 +168,7 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.html#subpackages">Subpackages</a><ul>
|
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.html#subpackages">Subpackages</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="vmware.vapi.vmc.html">vmware.vapi.vmc package</a><ul>
|
<li class="toctree-l3"><a class="reference internal" href="vmware.vapi.vmc.html">vmware.vapi.vmc package</a><ul>
|
||||||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.vmc.html#submodules">Submodules</a></li>
|
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.vmc.html#submodules">Submodules</a></li>
|
||||||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.client">vmware.vapi.vmc.client module</a></li>
|
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.vmc.html#vmware-vapi-vmc-client-module">vmware.vapi.vmc.client module</a></li>
|
||||||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter">vmware.vapi.vmc.csp_filter module</a></li>
|
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter">vmware.vapi.vmc.csp_filter module</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
@ -201,10 +201,11 @@
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2019, VMware, Inc. All rights reserved
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
</footer>
|
</footer>
|
||||||
|
|
||||||
|
|||||||
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>vmware.vapi package — vSphere Automation SDK for Python 1.9.0 documentation</title>
|
<title>vmware.vapi package — draas 1.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -50,7 +50,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
<a href="index.html" class="icon icon-home"> draas
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -60,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
1.9.0
|
1.1.0
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -111,7 +111,7 @@
|
|||||||
<nav class="wy-nav-top" aria-label="top navigation">
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
<a href="index.html">vSphere Automation SDK for Python</a>
|
<a href="index.html">draas</a>
|
||||||
|
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
@ -171,7 +171,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="vmware.vapi.vmc.html">vmware.vapi.vmc package</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="vmware.vapi.vmc.html">vmware.vapi.vmc package</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.vmc.html#submodules">Submodules</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.vmc.html#submodules">Submodules</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.client">vmware.vapi.vmc.client module</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.vmc.html#vmware-vapi-vmc-client-module">vmware.vapi.vmc.client module</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter">vmware.vapi.vmc.csp_filter module</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter">vmware.vapi.vmc.csp_filter module</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
@ -200,10 +200,11 @@
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2019, VMware, Inc. All rights reserved
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
</footer>
|
</footer>
|
||||||
|
|
||||||
|
|||||||
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>vmware.vapi.vmc package — vSphere Automation SDK for Python 1.9.0 documentation</title>
|
<title>vmware.vapi.vmc package — draas 1.1.0 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -49,7 +49,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
<a href="index.html" class="icon icon-home"> draas
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -59,7 +59,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
1.9.0
|
1.1.0
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -110,7 +110,7 @@
|
|||||||
<nav class="wy-nav-top" aria-label="top navigation">
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
|
||||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
<a href="index.html">vSphere Automation SDK for Python</a>
|
<a href="index.html">draas</a>
|
||||||
|
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
@ -169,142 +169,79 @@
|
|||||||
<div class="section" id="submodules">
|
<div class="section" id="submodules">
|
||||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="module-vmware.vapi.vmc.client">
|
<div class="section" id="vmware-vapi-vmc-client-module">
|
||||||
<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>
|
<h2>vmware.vapi.vmc.client module<a class="headerlink" href="#vmware-vapi-vmc-client-module" title="Permalink to this headline">¶</a></h2>
|
||||||
<p>CSP Refresh token based SecurityContextFilter</p>
|
|
||||||
<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>
|
|
||||||
<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>
|
|
||||||
</ul>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="class">
|
|
||||||
<dt id="vmware.vapi.vmc.client.VmcStubFactory">
|
|
||||||
<em class="property">class </em><code class="descclassname">vmware.vapi.vmc.client.</code><code class="descname">VmcStubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.client.VmcStubFactory" title="Permalink to this definition">¶</a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc_client.StubFactory</span></code></p>
|
|
||||||
</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>
|
|
||||||
<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>
|
|
||||||
</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></dl>
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="module-vmware.vapi.vmc.csp_filter">
|
<div class="section" id="module-vmware.vapi.vmc.csp_filter">
|
||||||
<span id="vmware-vapi-vmc-csp-filter-module"></span><h2>vmware.vapi.vmc.csp_filter module<a class="headerlink" href="#module-vmware.vapi.vmc.csp_filter" title="Permalink to this headline">¶</a></h2>
|
<span id="vmware-vapi-vmc-csp-filter-module"></span><h2>vmware.vapi.vmc.csp_filter module<a class="headerlink" href="#module-vmware.vapi.vmc.csp_filter" title="Permalink to this headline">¶</a></h2>
|
||||||
<p>CSP Refresh token based SecurityContextFilter</p>
|
<p>CSP Refresh token based SecurityContextFilter</p>
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter">
|
<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>
|
<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
|
<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>
|
context based on a refresh token to the execution context passed in.</p>
|
||||||
<p>Initialize SecurityContextFilter</p>
|
<p>Initialize SecurityContextFilter</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<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>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
<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><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><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
|
||||||
<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>
|
access token</p></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>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_max_retries">
|
<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>
|
<dd><p>Get the max number of retries</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Return type</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<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>
|
<dt class="field-even">Returns</dt>
|
||||||
</tr>
|
<dd class="field-even"><p>Number of retries</p>
|
||||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Number of retries</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_security_context">
|
<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
|
<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
|
occured, then a new access token is obtained using the refresh token and
|
||||||
a new security context is created.</p>
|
a new security context is created.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<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>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></p>
|
||||||
<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>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Security context</td>
|
<dd class="field-odd"><p>Security context</p>
|
||||||
</tr>
|
</dd>
|
||||||
</tbody>
|
</dl>
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.should_retry">
|
<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
|
<dd><p>Returns whether the request should be retried or not based on the error
|
||||||
specified.</p>
|
specified.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<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>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||||||
<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>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<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
|
<dd class="field-odd"><p>Returns True if request should be retried in case the error is
|
||||||
either Unauthenticated or Unauthorized else False</td>
|
either Unauthenticated or Unauthorized else False</p>
|
||||||
</tr>
|
</dd>
|
||||||
</tbody>
|
</dl>
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -330,10 +267,11 @@ either Unauthenticated or Unauthorized else False</td>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2019, VMware, Inc. All rights reserved
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
</footer>
|
</footer>
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user