mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
vSphere API reference for VMware Cloud on AWS 1.7
Signed-off-by: Tianhao He <het@vmware.com>
This commit is contained in:
Tianhao He
parent
85881b5e71
commit
f0e4973681
@ -17,6 +17,14 @@ com.vmware.appliance.networking.dns\_client module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.networking.firewall\_client module
|
||||
-------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.networking.firewall_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.networking.interfaces\_client module
|
||||
---------------------------------------------------------
|
||||
|
||||
|
||||
@ -12,6 +12,7 @@ Subpackages
|
||||
.. toctree::
|
||||
|
||||
com.vmware.content.library
|
||||
com.vmware.content.type
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
20
vsphere/cloud/_sources/com.vmware.content.type.ovf.rst.txt
Normal file
20
vsphere/cloud/_sources/com.vmware.content.type.ovf.rst.txt
Normal file
@ -0,0 +1,20 @@
|
||||
com.vmware.content.type.ovf package
|
||||
===================================
|
||||
|
||||
.. automodule:: com.vmware.content.type.ovf
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
com.vmware.content.type.ovf.policy\_client module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.content.type.ovf.policy_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
27
vsphere/cloud/_sources/com.vmware.content.type.rst.txt
Normal file
27
vsphere/cloud/_sources/com.vmware.content.type.rst.txt
Normal file
@ -0,0 +1,27 @@
|
||||
com.vmware.content.type package
|
||||
===============================
|
||||
|
||||
.. automodule:: com.vmware.content.type
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.content.type.ovf
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
com.vmware.content.type.ovf\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.content.type.ovf_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -44,6 +44,14 @@ com.vmware.content\_client module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vapi\_client module
|
||||
------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter\_client module
|
||||
---------------------------------
|
||||
|
||||
|
||||
@ -17,6 +17,14 @@ Subpackages
|
||||
Submodules
|
||||
----------
|
||||
|
||||
com.vmware.vapi.metadata\_client module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vapi.std\_client module
|
||||
----------------------------------
|
||||
|
||||
|
||||
@ -6,3 +6,15 @@ com.vmware.vapi.std package
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
com.vmware.vapi.std.errors\_client module
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.std.errors_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,20 @@
|
||||
com.vmware.vcenter.certificate\_management package
|
||||
==================================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.certificate_management
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
com.vmware.vcenter.certificate\_management.vcenter\_client module
|
||||
-----------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.certificate_management.vcenter_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -9,6 +9,14 @@ com.vmware.vcenter.compute.policies.capabilities package
|
||||
Submodules
|
||||
----------
|
||||
|
||||
com.vmware.vcenter.compute.policies.capabilities.disable\_drs\_vmotion\_client module
|
||||
-------------------------------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.compute.policies.capabilities.vm\_host\_affinity\_client module
|
||||
----------------------------------------------------------------------------------
|
||||
|
||||
@ -17,4 +25,28 @@ com.vmware.vcenter.compute.policies.capabilities.vm\_host\_affinity\_client modu
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.compute.policies.capabilities.vm\_host\_anti\_affinity\_client module
|
||||
----------------------------------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.compute.policies.capabilities.vm\_vm\_affinity\_client module
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.compute.policies.capabilities.vm\_vm\_anti\_affinity\_client module
|
||||
--------------------------------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
|
||||
@ -11,16 +11,26 @@ Subpackages
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vcenter.certificate_management
|
||||
com.vmware.vcenter.compute
|
||||
com.vmware.vcenter.deployment
|
||||
com.vmware.vcenter.hvc
|
||||
com.vmware.vcenter.storage
|
||||
com.vmware.vcenter.system_config
|
||||
com.vmware.vcenter.vcha
|
||||
com.vmware.vcenter.vm
|
||||
com.vmware.vcenter.vm_template
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
com.vmware.vcenter.certificate\_management\_client module
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.certificate_management_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.compute\_client module
|
||||
-----------------------------------------
|
||||
|
||||
@ -61,6 +71,14 @@ com.vmware.vcenter.hvc\_client module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.identity\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.identity_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.inventory\_client module
|
||||
-------------------------------------------
|
||||
|
||||
@ -77,6 +95,14 @@ com.vmware.vcenter.iso\_client module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.lcm\_client module
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.lcm_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.ovf\_client module
|
||||
-------------------------------------
|
||||
|
||||
@ -109,6 +135,30 @@ com.vmware.vcenter.system\_config\_client module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.tokenservice\_client module
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.tokenservice_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.topology\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.topology_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.vcha\_client module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vcha_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.vm\_client module
|
||||
------------------------------------
|
||||
|
||||
|
||||
@ -0,0 +1,20 @@
|
||||
com.vmware.vcenter.system\_config.features package
|
||||
==================================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.system_config.features
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
com.vmware.vcenter.system\_config.features.tech\_preview\_client module
|
||||
-----------------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.system_config.features.tech_preview_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -0,0 +1,15 @@
|
||||
com.vmware.vcenter.system\_config package
|
||||
=========================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.system_config
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vcenter.system_config.features
|
||||
|
||||
20
vsphere/cloud/_sources/com.vmware.vcenter.vcha.rst.txt
Normal file
20
vsphere/cloud/_sources/com.vmware.vcenter.vcha.rst.txt
Normal file
@ -0,0 +1,20 @@
|
||||
com.vmware.vcenter.vcha package
|
||||
===============================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vcha
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
com.vmware.vcenter.vcha.cluster\_client module
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vcha.cluster_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
.. vSphere Automation SDK for Python documentation master file, created by
|
||||
sphinx-quickstart on Wed Sep 19 04:21:51 2018.
|
||||
.. vSphere Automation SDK for Python. documentation master file, created by
|
||||
sphinx-quickstart on Mon May 27 04:22:27 2019.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to vSphere Automation SDK for Python's documentation!
|
||||
=============================================================
|
||||
Welcome to vSphere Automation SDK for Python.'s documentation!
|
||||
==============================================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 10
|
||||
|
||||
@ -13,8 +13,7 @@ Subpackages
|
||||
|
||||
vmware.vapi.lib
|
||||
vmware.vapi.security
|
||||
vmware.vapi.stdlib
|
||||
vmware.vapi.vmc
|
||||
vmware.vapi.vsphere
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
20
vsphere/cloud/_sources/vmware.vapi.vsphere.rst.txt
Normal file
20
vsphere/cloud/_sources/vmware.vapi.vsphere.rst.txt
Normal file
@ -0,0 +1,20 @@
|
||||
vmware.vapi.vsphere package
|
||||
===========================
|
||||
|
||||
.. automodule:: vmware.vapi.vsphere
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
vmware.vapi.vsphere.client module
|
||||
---------------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.vsphere.client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
@ -231,6 +231,16 @@ a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
a.brackets:before,
|
||||
span.brackets > a:before{
|
||||
content: "[";
|
||||
}
|
||||
|
||||
a.brackets:after,
|
||||
span.brackets > a:after {
|
||||
content: "]";
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
@ -391,6 +401,16 @@ table.citation td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
th > p:first-child,
|
||||
td > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
th > p:last-child,
|
||||
td > p:last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
@ -460,11 +480,57 @@ ol.upperroman {
|
||||
list-style: upper-roman;
|
||||
}
|
||||
|
||||
li > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
li > p:last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
dl.footnote > dt,
|
||||
dl.citation > dt {
|
||||
float: left;
|
||||
}
|
||||
|
||||
dl.footnote > dd,
|
||||
dl.citation > dd {
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl.footnote > dd:after,
|
||||
dl.citation > dd:after {
|
||||
content: "";
|
||||
clear: both;
|
||||
}
|
||||
|
||||
dl.field-list {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
dl.field-list > dt {
|
||||
flex-basis: 20%;
|
||||
font-weight: bold;
|
||||
word-break: break-word;
|
||||
}
|
||||
|
||||
dl.field-list > dt:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
dl.field-list > dd {
|
||||
flex-basis: 70%;
|
||||
padding-left: 1em;
|
||||
margin-left: 0em;
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd p {
|
||||
dd > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
@ -537,6 +603,12 @@ dl.glossary dt {
|
||||
font-style: oblique;
|
||||
}
|
||||
|
||||
.classifier:before {
|
||||
font-style: normal;
|
||||
margin: 0.5em;
|
||||
content: ":";
|
||||
}
|
||||
|
||||
abbr, acronym {
|
||||
border-bottom: dotted 1px;
|
||||
cursor: help;
|
||||
|
||||
@ -1 +1 @@
|
||||
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
||||
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -4,7 +4,7 @@
|
||||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
@ -87,14 +87,13 @@ jQuery.fn.highlightText = function(text, className) {
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
if (isInSVG) {
|
||||
var bbox = span.getBBox();
|
||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||
var bbox = node.parentElement.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute('class', className);
|
||||
var parentOfText = node.parentNode.parentNode;
|
||||
addItems.push({
|
||||
"parent": node.parentNode,
|
||||
"target": rect});
|
||||
|
||||
@ -1,296 +1,10 @@
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '6.8.1',
|
||||
VERSION: '6.8.7',
|
||||
LANGUAGE: 'en',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
NAVIGATION_WITH_KEYS: false,
|
||||
SEARCH_LANGUAGE_STOP_WORDS: ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]
|
||||
NAVIGATION_WITH_KEYS: false
|
||||
};
|
||||
|
||||
|
||||
|
||||
/* Non-minified version JS is _stemmer.js if file is provided */
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
var Stemmer = function() {
|
||||
|
||||
var step2list = {
|
||||
ational: 'ate',
|
||||
tional: 'tion',
|
||||
enci: 'ence',
|
||||
anci: 'ance',
|
||||
izer: 'ize',
|
||||
bli: 'ble',
|
||||
alli: 'al',
|
||||
entli: 'ent',
|
||||
eli: 'e',
|
||||
ousli: 'ous',
|
||||
ization: 'ize',
|
||||
ation: 'ate',
|
||||
ator: 'ate',
|
||||
alism: 'al',
|
||||
iveness: 'ive',
|
||||
fulness: 'ful',
|
||||
ousness: 'ous',
|
||||
aliti: 'al',
|
||||
iviti: 'ive',
|
||||
biliti: 'ble',
|
||||
logi: 'log'
|
||||
};
|
||||
|
||||
var step3list = {
|
||||
icate: 'ic',
|
||||
ative: '',
|
||||
alize: 'al',
|
||||
iciti: 'ic',
|
||||
ical: 'ic',
|
||||
ful: '',
|
||||
ness: ''
|
||||
};
|
||||
|
||||
var c = "[^aeiou]"; // consonant
|
||||
var v = "[aeiouy]"; // vowel
|
||||
var C = c + "[^aeiouy]*"; // consonant sequence
|
||||
var V = v + "[aeiou]*"; // vowel sequence
|
||||
|
||||
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
|
||||
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
|
||||
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
|
||||
var s_v = "^(" + C + ")?" + v; // vowel in stem
|
||||
|
||||
this.stemWord = function (w) {
|
||||
var stem;
|
||||
var suffix;
|
||||
var firstch;
|
||||
var origword = w;
|
||||
|
||||
if (w.length < 3)
|
||||
return w;
|
||||
|
||||
var re;
|
||||
var re2;
|
||||
var re3;
|
||||
var re4;
|
||||
|
||||
firstch = w.substr(0,1);
|
||||
if (firstch == "y")
|
||||
w = firstch.toUpperCase() + w.substr(1);
|
||||
|
||||
// Step 1a
|
||||
re = /^(.+?)(ss|i)es$/;
|
||||
re2 = /^(.+?)([^s])s$/;
|
||||
|
||||
if (re.test(w))
|
||||
w = w.replace(re,"$1$2");
|
||||
else if (re2.test(w))
|
||||
w = w.replace(re2,"$1$2");
|
||||
|
||||
// Step 1b
|
||||
re = /^(.+?)eed$/;
|
||||
re2 = /^(.+?)(ed|ing)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(fp[1])) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1];
|
||||
re2 = new RegExp(s_v);
|
||||
if (re2.test(stem)) {
|
||||
w = stem;
|
||||
re2 = /(at|bl|iz)$/;
|
||||
re3 = new RegExp("([^aeiouylsz])\\1$");
|
||||
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re2.test(w))
|
||||
w = w + "e";
|
||||
else if (re3.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
else if (re4.test(w))
|
||||
w = w + "e";
|
||||
}
|
||||
}
|
||||
|
||||
// Step 1c
|
||||
re = /^(.+?)y$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(s_v);
|
||||
if (re.test(stem))
|
||||
w = stem + "i";
|
||||
}
|
||||
|
||||
// Step 2
|
||||
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step2list[suffix];
|
||||
}
|
||||
|
||||
// Step 3
|
||||
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step3list[suffix];
|
||||
}
|
||||
|
||||
// Step 4
|
||||
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
|
||||
re2 = /^(.+?)(s|t)(ion)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
if (re.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1] + fp[2];
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re2.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
|
||||
// Step 5
|
||||
re = /^(.+?)e$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
re2 = new RegExp(meq1);
|
||||
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
|
||||
w = stem;
|
||||
}
|
||||
re = /ll$/;
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re.test(w) && re2.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
|
||||
// and turn initial Y back to y
|
||||
if (firstch == "y")
|
||||
w = firstch.toLowerCase() + w.substr(1);
|
||||
return w;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
var splitChars = (function() {
|
||||
var result = {};
|
||||
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
|
||||
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
|
||||
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
|
||||
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
|
||||
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
|
||||
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
|
||||
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
|
||||
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
|
||||
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
|
||||
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
|
||||
var i, j, start, end;
|
||||
for (i = 0; i < singles.length; i++) {
|
||||
result[singles[i]] = true;
|
||||
}
|
||||
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
|
||||
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
|
||||
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
|
||||
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
|
||||
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
|
||||
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
|
||||
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
|
||||
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
|
||||
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
|
||||
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
|
||||
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
|
||||
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
|
||||
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
|
||||
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
|
||||
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
|
||||
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
|
||||
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
|
||||
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
|
||||
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
|
||||
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
|
||||
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
|
||||
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
|
||||
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
|
||||
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
|
||||
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
|
||||
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
|
||||
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
|
||||
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
|
||||
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
|
||||
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
|
||||
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
|
||||
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
|
||||
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
|
||||
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
|
||||
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
|
||||
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
|
||||
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
|
||||
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
|
||||
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
|
||||
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
|
||||
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
|
||||
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
|
||||
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
|
||||
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
|
||||
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
|
||||
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
|
||||
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
|
||||
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
|
||||
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
|
||||
for (i = 0; i < ranges.length; i++) {
|
||||
start = ranges[i][0];
|
||||
end = ranges[i][1];
|
||||
for (j = start; j <= end; j++) {
|
||||
result[j] = true;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
})();
|
||||
|
||||
function splitQuery(query) {
|
||||
var result = [];
|
||||
var start = -1;
|
||||
for (var i = 0; i < query.length; i++) {
|
||||
if (splitChars[query.charCodeAt(i)]) {
|
||||
if (start !== -1) {
|
||||
result.push(query.slice(start, i));
|
||||
start = -1;
|
||||
}
|
||||
} else if (start === -1) {
|
||||
start = i;
|
||||
}
|
||||
}
|
||||
if (start !== -1) {
|
||||
result.push(query.slice(start));
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
|
||||
BIN
vsphere/cloud/_static/fonts/Inconsolata-Bold.ttf
Normal file
BIN
vsphere/cloud/_static/fonts/Inconsolata-Bold.ttf
Normal file
Binary file not shown.
BIN
vsphere/cloud/_static/fonts/Inconsolata-Regular.ttf
Normal file
BIN
vsphere/cloud/_static/fonts/Inconsolata-Regular.ttf
Normal file
Binary file not shown.
BIN
vsphere/cloud/_static/fonts/Inconsolata.ttf
Normal file
BIN
vsphere/cloud/_static/fonts/Inconsolata.ttf
Normal file
Binary file not shown.
BIN
vsphere/cloud/_static/fonts/Lato-Bold.ttf
Normal file
BIN
vsphere/cloud/_static/fonts/Lato-Bold.ttf
Normal file
Binary file not shown.
BIN
vsphere/cloud/_static/fonts/Lato-Regular.ttf
Normal file
BIN
vsphere/cloud/_static/fonts/Lato-Regular.ttf
Normal file
Binary file not shown.
BIN
vsphere/cloud/_static/fonts/RobotoSlab-Bold.ttf
Normal file
BIN
vsphere/cloud/_static/fonts/RobotoSlab-Bold.ttf
Normal file
Binary file not shown.
BIN
vsphere/cloud/_static/fonts/RobotoSlab-Regular.ttf
Normal file
BIN
vsphere/cloud/_static/fonts/RobotoSlab-Regular.ttf
Normal file
Binary file not shown.
@ -1,3 +1,3 @@
|
||||
/* sphinx_rtd_theme version 0.4.1 | MIT license */
|
||||
/* Built 20180727 10:07 */
|
||||
require=function n(e,i,t){function o(s,a){if(!i[s]){if(!e[s]){var l="function"==typeof require&&require;if(!a&&l)return l(s,!0);if(r)return r(s,!0);var c=new Error("Cannot find module '"+s+"'");throw c.code="MODULE_NOT_FOUND",c}var u=i[s]={exports:{}};e[s][0].call(u.exports,function(n){var i=e[s][1][n];return o(i||n)},u,u.exports,n,e,i,t)}return i[s].exports}for(var r="function"==typeof require&&require,s=0;s<t.length;s++)o(t[s]);return o}({"sphinx-rtd-theme":[function(n,e,i){var jQuery="undefined"!=typeof window?window.jQuery:n("jquery");e.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var e=this;void 0===n&&(n=!0),e.isRunning||(e.isRunning=!0,jQuery(function(i){e.init(i),e.reset(),e.win.on("hashchange",e.reset),n&&e.win.on("scroll",function(){e.linkScroll||e.winScroll||(e.winScroll=!0,requestAnimationFrame(function(){e.onScroll()}))}),e.win.on("resize",function(){e.winResize||(e.winResize=!0,requestAnimationFrame(function(){e.onResize()}))}),e.onResize()}))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")}).on("click",".wy-menu-vertical .current ul li a",function(){var i=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(i),e.hashChange()}).on("click","[data-toggle='rst-current-version']",function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")}),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),n("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),n("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var i=n(this);expand=n('<span class="toctree-expand"></span>'),expand.on("click",function(n){return e.toggleCurrent(i),n.stopPropagation(),!1}),i.prepend(expand)})},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),i=e.find('[href="'+n+'"]');if(0===i.length){var t=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(i=e.find('[href="#'+t.attr("id")+'"]')).length&&(i=e.find('[href="#"]'))}i.length>0&&($(".wy-menu-vertical .current").removeClass("current"),i.addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l1").parent().addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l2").addClass("current"),i.closest("li.toctree-l3").addClass("current"),i.closest("li.toctree-l4").addClass("current"))}catch(o){console.log("Error expanding nav for anchor",o)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,i=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(i),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:e.exports.ThemeNav,StickyNav:e.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],i=0;i<e.length&&!window.requestAnimationFrame;++i)window.requestAnimationFrame=window[e[i]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[e[i]+"CancelAnimationFrame"]||window[e[i]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(e,i){var t=(new Date).getTime(),o=Math.max(0,16-(t-n)),r=window.setTimeout(function(){e(t+o)},o);return n=t+o,r}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()},{jquery:"jquery"}]},{},["sphinx-rtd-theme"]);
|
||||
/* sphinx_rtd_theme version 0.4.3 | MIT license */
|
||||
/* Built 20190212 16:02 */
|
||||
require=function r(s,a,l){function c(e,n){if(!a[e]){if(!s[e]){var i="function"==typeof require&&require;if(!n&&i)return i(e,!0);if(u)return u(e,!0);var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}var o=a[e]={exports:{}};s[e][0].call(o.exports,function(n){return c(s[e][1][n]||n)},o,o.exports,r,s,a,l)}return a[e].exports}for(var u="function"==typeof require&&require,n=0;n<l.length;n++)c(l[n]);return c}({"sphinx-rtd-theme":[function(n,e,i){var jQuery="undefined"!=typeof window?window.jQuery:n("jquery");e.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(e){var i=this;void 0===e&&(e=!0),i.isRunning||(i.isRunning=!0,jQuery(function(n){i.init(n),i.reset(),i.win.on("hashchange",i.reset),e&&i.win.on("scroll",function(){i.linkScroll||i.winScroll||(i.winScroll=!0,requestAnimationFrame(function(){i.onScroll()}))}),i.win.on("resize",function(){i.winResize||(i.winResize=!0,requestAnimationFrame(function(){i.onResize()}))}),i.onResize()}))},enableSticky:function(){this.enable(!0)},init:function(i){i(document);var t=this;this.navBar=i("div.wy-side-scroll:first"),this.win=i(window),i(document).on("click","[data-toggle='wy-nav-top']",function(){i("[data-toggle='wy-nav-shift']").toggleClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift")}).on("click",".wy-menu-vertical .current ul li a",function(){var n=i(this);i("[data-toggle='wy-nav-shift']").removeClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift"),t.toggleCurrent(n),t.hashChange()}).on("click","[data-toggle='rst-current-version']",function(){i("[data-toggle='rst-versions']").toggleClass("shift-up")}),i("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),i("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),i("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),i(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var e=i(this);expand=i('<span class="toctree-expand"></span>'),expand.on("click",function(n){return t.toggleCurrent(e),n.stopPropagation(),!1}),e.prepend(expand)})},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),i=e.find('[href="'+n+'"]');if(0===i.length){var t=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(i=e.find('[href="#'+t.attr("id")+'"]')).length&&(i=e.find('[href="#"]'))}0<i.length&&($(".wy-menu-vertical .current").removeClass("current"),i.addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l1").parent().addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l2").addClass("current"),i.closest("li.toctree-l3").addClass("current"),i.closest("li.toctree-l4").addClass("current"),i[0].scrollIntoView())}catch(o){console.log("Error expanding nav for anchor",o)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,i=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(i),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:e.exports.ThemeNav,StickyNav:e.exports.ThemeNav}),function(){for(var r=0,n=["ms","moz","webkit","o"],e=0;e<n.length&&!window.requestAnimationFrame;++e)window.requestAnimationFrame=window[n[e]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[n[e]+"CancelAnimationFrame"]||window[n[e]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(n,e){var i=(new Date).getTime(),t=Math.max(0,16-(i-r)),o=window.setTimeout(function(){n(i+t)},t);return r=i+t,o}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()},{jquery:"jquery"}]},{},["sphinx-rtd-theme"]);
|
||||
297
vsphere/cloud/_static/language_data.js
Normal file
297
vsphere/cloud/_static/language_data.js
Normal file
@ -0,0 +1,297 @@
|
||||
/*
|
||||
* language_data.js
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* This script contains the language-specific data used by searchtools.js,
|
||||
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||
*
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
|
||||
|
||||
|
||||
/* Non-minified version JS is _stemmer.js if file is provided */
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
var Stemmer = function() {
|
||||
|
||||
var step2list = {
|
||||
ational: 'ate',
|
||||
tional: 'tion',
|
||||
enci: 'ence',
|
||||
anci: 'ance',
|
||||
izer: 'ize',
|
||||
bli: 'ble',
|
||||
alli: 'al',
|
||||
entli: 'ent',
|
||||
eli: 'e',
|
||||
ousli: 'ous',
|
||||
ization: 'ize',
|
||||
ation: 'ate',
|
||||
ator: 'ate',
|
||||
alism: 'al',
|
||||
iveness: 'ive',
|
||||
fulness: 'ful',
|
||||
ousness: 'ous',
|
||||
aliti: 'al',
|
||||
iviti: 'ive',
|
||||
biliti: 'ble',
|
||||
logi: 'log'
|
||||
};
|
||||
|
||||
var step3list = {
|
||||
icate: 'ic',
|
||||
ative: '',
|
||||
alize: 'al',
|
||||
iciti: 'ic',
|
||||
ical: 'ic',
|
||||
ful: '',
|
||||
ness: ''
|
||||
};
|
||||
|
||||
var c = "[^aeiou]"; // consonant
|
||||
var v = "[aeiouy]"; // vowel
|
||||
var C = c + "[^aeiouy]*"; // consonant sequence
|
||||
var V = v + "[aeiou]*"; // vowel sequence
|
||||
|
||||
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
|
||||
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
|
||||
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
|
||||
var s_v = "^(" + C + ")?" + v; // vowel in stem
|
||||
|
||||
this.stemWord = function (w) {
|
||||
var stem;
|
||||
var suffix;
|
||||
var firstch;
|
||||
var origword = w;
|
||||
|
||||
if (w.length < 3)
|
||||
return w;
|
||||
|
||||
var re;
|
||||
var re2;
|
||||
var re3;
|
||||
var re4;
|
||||
|
||||
firstch = w.substr(0,1);
|
||||
if (firstch == "y")
|
||||
w = firstch.toUpperCase() + w.substr(1);
|
||||
|
||||
// Step 1a
|
||||
re = /^(.+?)(ss|i)es$/;
|
||||
re2 = /^(.+?)([^s])s$/;
|
||||
|
||||
if (re.test(w))
|
||||
w = w.replace(re,"$1$2");
|
||||
else if (re2.test(w))
|
||||
w = w.replace(re2,"$1$2");
|
||||
|
||||
// Step 1b
|
||||
re = /^(.+?)eed$/;
|
||||
re2 = /^(.+?)(ed|ing)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(fp[1])) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1];
|
||||
re2 = new RegExp(s_v);
|
||||
if (re2.test(stem)) {
|
||||
w = stem;
|
||||
re2 = /(at|bl|iz)$/;
|
||||
re3 = new RegExp("([^aeiouylsz])\\1$");
|
||||
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re2.test(w))
|
||||
w = w + "e";
|
||||
else if (re3.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
else if (re4.test(w))
|
||||
w = w + "e";
|
||||
}
|
||||
}
|
||||
|
||||
// Step 1c
|
||||
re = /^(.+?)y$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(s_v);
|
||||
if (re.test(stem))
|
||||
w = stem + "i";
|
||||
}
|
||||
|
||||
// Step 2
|
||||
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step2list[suffix];
|
||||
}
|
||||
|
||||
// Step 3
|
||||
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step3list[suffix];
|
||||
}
|
||||
|
||||
// Step 4
|
||||
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
|
||||
re2 = /^(.+?)(s|t)(ion)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
if (re.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1] + fp[2];
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re2.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
|
||||
// Step 5
|
||||
re = /^(.+?)e$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
re2 = new RegExp(meq1);
|
||||
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
|
||||
w = stem;
|
||||
}
|
||||
re = /ll$/;
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re.test(w) && re2.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
|
||||
// and turn initial Y back to y
|
||||
if (firstch == "y")
|
||||
w = firstch.toLowerCase() + w.substr(1);
|
||||
return w;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
var splitChars = (function() {
|
||||
var result = {};
|
||||
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
|
||||
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
|
||||
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
|
||||
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
|
||||
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
|
||||
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
|
||||
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
|
||||
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
|
||||
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
|
||||
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
|
||||
var i, j, start, end;
|
||||
for (i = 0; i < singles.length; i++) {
|
||||
result[singles[i]] = true;
|
||||
}
|
||||
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
|
||||
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
|
||||
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
|
||||
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
|
||||
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
|
||||
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
|
||||
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
|
||||
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
|
||||
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
|
||||
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
|
||||
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
|
||||
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
|
||||
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
|
||||
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
|
||||
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
|
||||
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
|
||||
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
|
||||
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
|
||||
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
|
||||
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
|
||||
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
|
||||
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
|
||||
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
|
||||
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
|
||||
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
|
||||
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
|
||||
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
|
||||
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
|
||||
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
|
||||
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
|
||||
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
|
||||
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
|
||||
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
|
||||
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
|
||||
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
|
||||
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
|
||||
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
|
||||
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
|
||||
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
|
||||
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
|
||||
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
|
||||
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
|
||||
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
|
||||
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
|
||||
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
|
||||
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
|
||||
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
|
||||
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
|
||||
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
|
||||
for (i = 0; i < ranges.length; i++) {
|
||||
start = ranges[i][0];
|
||||
end = ranges[i][1];
|
||||
for (j = start; j <= end; j++) {
|
||||
result[j] = true;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
})();
|
||||
|
||||
function splitQuery(query) {
|
||||
var result = [];
|
||||
var start = -1;
|
||||
for (var i = 0; i < query.length; i++) {
|
||||
if (splitChars[query.charCodeAt(i)]) {
|
||||
if (start !== -1) {
|
||||
result.push(query.slice(start, i));
|
||||
start = -1;
|
||||
}
|
||||
} else if (start === -1) {
|
||||
start = i;
|
||||
}
|
||||
}
|
||||
if (start !== -1) {
|
||||
result.push(query.slice(start));
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
*
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
@ -36,8 +36,10 @@ if (!Scorer) {
|
||||
|
||||
// query found in title
|
||||
title: 15,
|
||||
partialTitle: 7,
|
||||
// query found in terms
|
||||
term: 5
|
||||
term: 5,
|
||||
partialTerm: 2
|
||||
};
|
||||
}
|
||||
|
||||
@ -56,6 +58,14 @@ var Search = {
|
||||
_queued_query : null,
|
||||
_pulse_status : -1,
|
||||
|
||||
htmlToText : function(htmlString) {
|
||||
var htmlElement = document.createElement('span');
|
||||
htmlElement.innerHTML = htmlString;
|
||||
$(htmlElement).find('.headerlink').remove();
|
||||
docContent = $(htmlElement).find('[role=main]')[0];
|
||||
return docContent.textContent || docContent.innerText;
|
||||
},
|
||||
|
||||
init : function() {
|
||||
var params = $.getQueryParameters();
|
||||
if (params.q) {
|
||||
@ -120,7 +130,7 @@ var Search = {
|
||||
this.out = $('#search-results');
|
||||
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||
this.dots = $('<span></span>').appendTo(this.title);
|
||||
this.status = $('<p style="display: none"></p>').appendTo(this.out);
|
||||
this.status = $('<p class="search-summary"> </p>').appendTo(this.out);
|
||||
this.output = $('<ul class="search"/>').appendTo(this.out);
|
||||
|
||||
$('#search-progress').text(_('Preparing search...'));
|
||||
@ -138,7 +148,6 @@ var Search = {
|
||||
*/
|
||||
query : function(query) {
|
||||
var i;
|
||||
var stopwords = DOCUMENTATION_OPTIONS.SEARCH_LANGUAGE_STOP_WORDS;
|
||||
|
||||
// stem the searchterms and add them to the correct list
|
||||
var stemmer = new Stemmer();
|
||||
@ -260,11 +269,7 @@ var Search = {
|
||||
displayNextItem();
|
||||
});
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
|
||||
if (suffix === undefined) {
|
||||
suffix = '.txt';
|
||||
}
|
||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
|
||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
|
||||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
@ -386,6 +391,19 @@ var Search = {
|
||||
{files: terms[word], score: Scorer.term},
|
||||
{files: titleterms[word], score: Scorer.title}
|
||||
];
|
||||
// add support for partial matches
|
||||
if (word.length > 2) {
|
||||
for (var w in terms) {
|
||||
if (w.match(word) && !terms[word]) {
|
||||
_o.push({files: terms[w], score: Scorer.partialTerm})
|
||||
}
|
||||
}
|
||||
for (var w in titleterms) {
|
||||
if (w.match(word) && !titleterms[word]) {
|
||||
_o.push({files: titleterms[w], score: Scorer.partialTitle})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// no match but word was a required one
|
||||
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||
@ -425,8 +443,12 @@ var Search = {
|
||||
var valid = true;
|
||||
|
||||
// check if all requirements are matched
|
||||
if (fileMap[file].length != searchterms.length)
|
||||
continue;
|
||||
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
|
||||
searchterms.filter(function(term){return term.length > 2}).length
|
||||
if (
|
||||
fileMap[file].length != searchterms.length &&
|
||||
fileMap[file].length != filteredTermCount
|
||||
) continue;
|
||||
|
||||
// ensure that none of the excluded terms is in the search result
|
||||
for (i = 0; i < excluded.length; i++) {
|
||||
@ -457,7 +479,8 @@ var Search = {
|
||||
* words. the first one is used to find the occurrence, the
|
||||
* latter for highlighting it.
|
||||
*/
|
||||
makeSearchSummary : function(text, keywords, hlwords) {
|
||||
makeSearchSummary : function(htmlText, keywords, hlwords) {
|
||||
var text = Search.htmlToText(htmlText);
|
||||
var textLower = text.toLowerCase();
|
||||
var start = 0;
|
||||
$.each(keywords, function() {
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -29,11 +36,7 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware package" href="com.vmware.html" />
|
||||
<link rel="prev" title="Welcome to vSphere Automation SDK for Python’s documentation!" href="index.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
<link rel="prev" title="Welcome to vSphere Automation SDK for Python.’s documentation!" href="index.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -106,7 +108,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -169,6 +171,7 @@
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.appliance.networking.html">com.vmware.appliance.networking package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.networking.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.dns_client">com.vmware.appliance.networking.dns_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.firewall_client">com.vmware.appliance.networking.firewall_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.interfaces_client">com.vmware.appliance.networking.interfaces_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -234,6 +237,19 @@
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.library.html#module-com.vmware.content.library.item_client">com.vmware.content.library.item_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.content.type.html">com.vmware.content.type package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.type.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.content.type.ovf.html">com.vmware.content.type.ovf package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.type.ovf.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.type.ovf.html#module-com.vmware.content.type.ovf.policy_client">com.vmware.content.type.ovf.policy_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.type.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.type.html#module-com.vmware.content.type.ovf_client">com.vmware.content.type.ovf_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.content.html#submodules">Submodules</a></li>
|
||||
@ -269,22 +285,36 @@
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.privilege_client">com.vmware.vapi.metadata.privilege_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vapi.std.html">com.vmware.vapi.std package</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vapi.std.html">com.vmware.vapi.std package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.std.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.errors_client">com.vmware.vapi.std.errors_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.html#module-com.vmware.vapi.metadata_client">com.vmware.vapi.metadata_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.html#module-com.vmware.vapi.std_client">com.vmware.vapi.std_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.html">com.vmware.vcenter package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html">com.vmware.vcenter.certificate_management package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#module-com.vmware.vcenter.certificate_management.vcenter_client">com.vmware.vcenter.certificate_management.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.compute.html">com.vmware.vcenter.compute package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html">com.vmware.vcenter.compute.policies package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html">com.vmware.vcenter.compute.policies.capabilities package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -347,6 +377,22 @@
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.storage.html#module-com.vmware.vcenter.storage.policies_client">com.vmware.vcenter.storage.policies_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.system_config.html">com.vmware.vcenter.system_config package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.system_config.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html">com.vmware.vcenter.system_config.features package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#module-com.vmware.vcenter.system_config.features.tech_preview_client">com.vmware.vcenter.system_config.features.tech_preview_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.vcha.html">com.vmware.vcenter.vcha package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vcha.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vcha.html#module-com.vmware.vcenter.vcha.cluster_client">com.vmware.vcenter.vcha.cluster_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.vm.html">com.vmware.vcenter.vm package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html">com.vmware.vcenter.vm.hardware package</a><ul>
|
||||
@ -369,25 +415,26 @@
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.storage_client">com.vmware.vcenter.vm.storage_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.vm_template.html">com.vmware.vcenter.vm_template package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#module-com.vmware.vcenter.vm_template.library_items_client">com.vmware.vcenter.vm_template.library_items_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.certificate_management_client">com.vmware.vcenter.certificate_management_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.compute_client">com.vmware.vcenter.compute_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.datastore_client">com.vmware.vcenter.datastore_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.deployment_client">com.vmware.vcenter.deployment_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.guest_client">com.vmware.vcenter.guest_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.hvc_client">com.vmware.vcenter.hvc_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.identity_client">com.vmware.vcenter.identity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.inventory_client">com.vmware.vcenter.inventory_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.iso_client">com.vmware.vcenter.iso_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.lcm_client">com.vmware.vcenter.lcm_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.ovf_client">com.vmware.vcenter.ovf_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.services_client">com.vmware.vcenter.services_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.storage_client">com.vmware.vcenter.storage_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.system_config_client">com.vmware.vcenter.system_config_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.tokenservice_client">com.vmware.vcenter.tokenservice_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.topology_client">com.vmware.vcenter.topology_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.vcha_client">com.vmware.vcenter.vcha_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.vm_client">com.vmware.vcenter.vm_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.vm_template_client">com.vmware.vcenter.vm_template_client module</a></li>
|
||||
</ul>
|
||||
@ -398,6 +445,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -417,7 +465,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="index.html" class="btn btn-neutral" title="Welcome to vSphere Automation SDK for Python’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 vSphere Automation SDK for Python.’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -426,7 +474,7 @@
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -443,33 +491,16 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.appliance.recovery.backup package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.appliance.recovery.backup package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.appliance.system package" href="com.vmware.appliance.system.html" />
|
||||
<link rel="prev" title="com.vmware.appliance.recovery package" href="com.vmware.appliance.recovery.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -184,142 +187,161 @@
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.backup.job_client.</code><code class="descname">Details</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Details</span></code> class provides methods to get the details about backup
|
||||
jobs. This class was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
jobs. This class was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.BuildInfo">
|
||||
<em class="property">class </em><code class="descname">BuildInfo</code><span class="sig-paren">(</span><em>version_name=None</em>, <em>version=None</em>, <em>build_number=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.BuildInfo" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Details.BuildInfo</span></code> class contains information about the build of the
|
||||
appliance. This class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>version_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Appliance product type, for example 6.8.2 GA. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Appliance version, for example 6.8.2.10000. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>build_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Build Number of the appliance. This attribute was added in vSphere
|
||||
API 6.7.2.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec">
|
||||
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>jobs=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Details.FilterSpec</span></code> class contains attributes used to filter the
|
||||
results when listing backup jobs details (see <a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.list" title="com.vmware.appliance.recovery.backup.job_client.Details.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Details.list()</span></code></a>). This
|
||||
class was added in vSphere API 6.7</p>
|
||||
class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>jobs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – Identifiers of backup jobs that can match the filter. This
|
||||
attribute was added in vSphere API 6.7
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>jobs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – Identifiers of backup jobs that can match the filter. This
|
||||
attribute was added in vSphere API 6.7.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.job</span></code>. When methods return a
|
||||
value of this class as a return value, the attribute will contain
|
||||
identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.job</span></code>.
|
||||
If None the filter will match all the backup jobs.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
If None the filter will match all the backup jobs.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>location=None</em>, <em>duration=None</em>, <em>size=None</em>, <em>progress=None</em>, <em>location_user=None</em>, <em>type=None</em>, <em>messages=None</em>, <em>description=None</em>, <em>service=None</em>, <em>operation=None</em>, <em>parent=None</em>, <em>target=None</em>, <em>status=None</em>, <em>cancelable=None</em>, <em>error=None</em>, <em>start_time=None</em>, <em>end_time=None</em>, <em>user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>location=None</em>, <em>duration=None</em>, <em>size=None</em>, <em>progress=None</em>, <em>location_user=None</em>, <em>type=None</em>, <em>messages=None</em>, <em>build=None</em>, <em>description=None</em>, <em>service=None</em>, <em>operation=None</em>, <em>parent=None</em>, <em>target=None</em>, <em>status=None</em>, <em>cancelable=None</em>, <em>error=None</em>, <em>start_time=None</em>, <em>end_time=None</em>, <em>user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.Info" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Details.Info</span></code> class contains information about a backup job. This
|
||||
class was added in vSphere API 6.7</p>
|
||||
class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the backup location. This attribute was added in vSphere API
|
||||
6.7</li>
|
||||
<li><strong>duration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Time in seconds since the backup job was started or the time it
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the backup location. This attribute was added in vSphere API
|
||||
6.7.</p></li>
|
||||
<li><p><strong>duration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Time in seconds since the backup job was started or the time it
|
||||
took to complete the backup job. This attribute was added in
|
||||
vSphere API 6.7
|
||||
vSphere API 6.7.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>,
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>, or
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>.</li>
|
||||
<li><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Size of the backup data transferred to remote location. This
|
||||
attribute was added in vSphere API 6.7
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>.</p></li>
|
||||
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Size of the backup data transferred to remote location. This
|
||||
attribute was added in vSphere API 6.7.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>,
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>, or
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>.</li>
|
||||
<li><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) – Progress of the job. This attribute was added in vSphere API 6.7
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>.</p></li>
|
||||
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) – Progress of the job. This attribute was added in vSphere API 6.7.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>,
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>, or
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>.</li>
|
||||
<li><strong>location_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The username for the remote backup location. This attribute was
|
||||
added in vSphere API 6.7</li>
|
||||
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.Type" title="com.vmware.appliance.recovery.backup.job_client.Details.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.Type</span></code></a>) – Type of the backup job. Indicates whether the backup was started
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>.</p></li>
|
||||
<li><p><strong>location_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The username for the remote backup location. This attribute was
|
||||
added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.Type" title="com.vmware.appliance.recovery.backup.job_client.Details.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.Type</span></code></a>) – Type of the backup job. Indicates whether the backup was started
|
||||
manually or as a scheduled backup. This attribute was added in
|
||||
vSphere API 6.7</li>
|
||||
<li><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – List of any info/warning/error messages returned by the backup job.
|
||||
This attribute was added in vSphere API 6.7</li>
|
||||
<li><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</li>
|
||||
<li><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the service containing the operation.
|
||||
vSphere API 6.7.</p></li>
|
||||
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – List of any info/warning/error messages returned by the backup job.
|
||||
This attribute was added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>build</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.BuildInfo" title="com.vmware.appliance.recovery.backup.job_client.Details.BuildInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.BuildInfo</span></code></a>) – Information about the build of the appliance. This attribute was
|
||||
added in vSphere API 6.7.2.
|
||||
This attribute is optional because it was added in a newer version
|
||||
than its parent node.</p></li>
|
||||
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
|
||||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</li>
|
||||
<li><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the operation associated with the task.
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||||
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</li>
|
||||
<li><strong>parent</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>) – Parent of the current task.
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||||
<li><p><strong>parent</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>) – Parent of the current task.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
|
||||
as a return value, the attribute will be an identifier for the
|
||||
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
|
||||
This attribute will be None if the task has no parent.</li>
|
||||
<li><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
|
||||
This attribute will be None if the task has no parent.</p></li>
|
||||
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
|
||||
one the operation performed on.
|
||||
This attribute will be None if the operation has no target or
|
||||
multiple targets.</li>
|
||||
<li><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</li>
|
||||
<li><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
|
||||
value may change as the operation progresses.</li>
|
||||
<li><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
|
||||
multiple targets.</p></li>
|
||||
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
|
||||
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
|
||||
value may change as the operation progresses.</p></li>
|
||||
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
|
||||
If None the description of why the operation failed will be
|
||||
included in the result of the operation (see
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</li>
|
||||
<li><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started.
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</p></li>
|
||||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</li>
|
||||
<li><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed.
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
||||
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</li>
|
||||
<li><strong>user</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>) – Name of the user who performed the operation.
|
||||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
||||
<li><p><strong>user</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>) – Name of the user who performed the operation.
|
||||
This attribute will be None if the operation is performed by the
|
||||
system.</li>
|
||||
system.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -327,10 +349,10 @@ system.</li>
|
||||
<em class="property">class </em><code class="descname">Type</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.Type" 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.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Details.Type</span></code> class defines the type of backup job. This enumeration
|
||||
was added in vSphere API 6.7</p>
|
||||
was added in vSphere API 6.7.</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">This class represents an enumerated type in the interface language
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. 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
|
||||
@ -338,24 +360,21 @@ enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.Type.MANUAL">
|
||||
<code class="descname">MANUAL</code><em class="property"> = Type(string='MANUAL')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.Type.MANUAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Job type is Manual. This class attribute was added in vSphere API 6.7</p>
|
||||
<dd><p>Job type is Manual. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.Type.SCHEDULED">
|
||||
<code class="descname">SCHEDULED</code><em class="property"> = Type(string='SCHEDULED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.Type.SCHEDULED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Job type is Scheduled. This class attribute was added in vSphere API 6.7</p>
|
||||
<dd><p>Job type is Scheduled. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -364,28 +383,28 @@ type description page</span></a>.</p>
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns detailed information about the current and historical backup
|
||||
jobs. This method was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec" title="com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of matching backup jobs for which information should
|
||||
jobs. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec" title="com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of matching backup jobs for which information should
|
||||
be returned.
|
||||
If None, the behavior is equivalent to <a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec" title="com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.FilterSpec</span></code></a>
|
||||
with all attributes None which means all the backup jobs match the
|
||||
filter.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.Info" title="com.vmware.appliance.recovery.backup.job_client.Details.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.Info</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Map of backup job identifier to Info Structure.
|
||||
filter.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.Info" title="com.vmware.appliance.recovery.backup.job_client.Details.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Details.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Map of backup job identifier to Info Structure.
|
||||
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.job</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
if any error occurs during the execution of the operation.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.job</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if any error occurs during the execution of the operation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -395,14 +414,11 @@ if any error occurs during the execution of the operation.</td>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.backup.job_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.appliance.recovery.backup.job_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -413,15 +429,12 @@ if any error occurs during the execution of the operation.</td>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.backup.system_name_client.</code><code class="descname">Archive</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Archive</span></code> class provides methods to get the backup information. This
|
||||
class was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
class was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec">
|
||||
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>start_timestamp=None</em>, <em>end_timestamp=None</em>, <em>comment_substring=None</em>, <em>max_results=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||||
@ -429,34 +442,30 @@ class was added in vSphere API 6.7</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Archive.FilterSpec</span></code> class contains attributes used to filter the
|
||||
results when listing backup archives (see <a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.list" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Archive.list()</span></code></a>). If
|
||||
multiple attributes are specified, only backup archives matching all of the
|
||||
attributes match the filter. This class was added in vSphere API 6.7</p>
|
||||
attributes match the filter. This class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>start_timestamp</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>) – Backup must have been taken on or after this time to match the
|
||||
filter. This attribute was added in vSphere API 6.7
|
||||
If None the filter will match oldest backups.</li>
|
||||
<li><strong>end_timestamp</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>) – Backup must have been taken on or before this time to match the
|
||||
filter. This attribute was added in vSphere API 6.7
|
||||
If None the filter will match most recent backups.</li>
|
||||
<li><strong>comment_substring</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>) – Backup comment must contain this <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> to match the filter.
|
||||
This attribute was added in vSphere API 6.7
|
||||
If None the filter will match backups with any comment.</li>
|
||||
<li><strong>max_results</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>) – Limit result to a max count of most recent backups. This attribute
|
||||
was added in vSphere API 6.7
|
||||
If None it defaults to 128.</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>start_timestamp</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>) – Backup must have been taken on or after this time to match the
|
||||
filter. This attribute was added in vSphere API 6.7.
|
||||
If None the filter will match oldest backups.</p></li>
|
||||
<li><p><strong>end_timestamp</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>) – Backup must have been taken on or before this time to match the
|
||||
filter. This attribute was added in vSphere API 6.7.
|
||||
If None the filter will match most recent backups.</p></li>
|
||||
<li><p><strong>comment_substring</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>) – Backup comment must contain this <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> to match the filter.
|
||||
This attribute was added in vSphere API 6.7.
|
||||
If None the filter will match backups with any comment.</p></li>
|
||||
<li><p><strong>max_results</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>) – Limit result to a max count of most recent backups. This attribute
|
||||
was added in vSphere API 6.7.
|
||||
If None it defaults to 128.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -464,39 +473,35 @@ If None it defaults to 128.</li>
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>timestamp=None</em>, <em>location=None</em>, <em>parts=None</em>, <em>version=None</em>, <em>system_name=None</em>, <em>comment=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.Info" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Archive.Info</span></code> class represents backup archive information. This
|
||||
class was added in vSphere API 6.7</p>
|
||||
class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>timestamp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when this backup was completed. This attribute was added in
|
||||
vSphere API 6.7</li>
|
||||
<li><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Backup location URL. This attribute was added in vSphere API 6.7</li>
|
||||
<li><strong>parts</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>) – List of parts included in the backup. This attribute was added in
|
||||
vSphere API 6.7</li>
|
||||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the appliance represented by the backup. This
|
||||
attribute was added in vSphere API 6.7</li>
|
||||
<li><strong>system_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The system name identifier of the appliance represented by the
|
||||
backup. This attribute was added in vSphere API 6.7
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>timestamp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when this backup was completed. This attribute was added in
|
||||
vSphere API 6.7.</p></li>
|
||||
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Backup location URL. This attribute was added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>parts</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>) – List of parts included in the backup. This attribute was added in
|
||||
vSphere API 6.7.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the appliance represented by the backup. This
|
||||
attribute was added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>system_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The system name identifier of the appliance represented by the
|
||||
backup. This attribute was added in vSphere API 6.7.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name</span></code>.</li>
|
||||
<li><strong>comment</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Custom comment added by the user for this backup. This attribute
|
||||
was added in vSphere API 6.7</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name</span></code>.</p></li>
|
||||
<li><p><strong>comment</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Custom comment added by the user for this backup. This attribute
|
||||
was added in vSphere API 6.7.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -504,74 +509,66 @@ was added in vSphere API 6.7</li>
|
||||
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>archive=None</em>, <em>timestamp=None</em>, <em>version=None</em>, <em>comment=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.Summary" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Archive.Summary</span></code> class contains commonly used information about a
|
||||
backup archive. This class was added in vSphere API 6.7</p>
|
||||
backup archive. This class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>archive</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Backup archive identifier. This attribute was added in vSphere API
|
||||
6.7
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>archive</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Backup archive identifier. This attribute was added in vSphere API
|
||||
6.7.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name.archive</span></code>. When
|
||||
methods return a value of this class as a return value, the
|
||||
attribute will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name.archive</span></code>.</li>
|
||||
<li><strong>timestamp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when this backup was started. This attribute was added in
|
||||
vSphere API 6.7</li>
|
||||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the appliance represented by the backup archive.
|
||||
This attribute was added in vSphere API 6.7</li>
|
||||
<li><strong>comment</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Custom comment added by the user for this backup. This attribute
|
||||
was added in vSphere API 6.7</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name.archive</span></code>.</p></li>
|
||||
<li><p><strong>timestamp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when this backup was started. This attribute was added in
|
||||
vSphere API 6.7.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the appliance represented by the backup archive.
|
||||
This attribute was added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>comment</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Custom comment added by the user for this backup. This attribute
|
||||
was added in vSphere API 6.7.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.Archive.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>spec</em>, <em>system_name</em>, <em>archive</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the information for backup corresponding to given backup
|
||||
location and system name. This method was added in vSphere API 6.7</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>spec</strong> (<a class="reference internal" href="com.vmware.appliance.recovery.html#com.vmware.appliance.recovery.backup_client.LocationSpec" title="com.vmware.appliance.recovery.backup_client.LocationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup_client.LocationSpec</span></code></a>) – LocationSpec Structure.</li>
|
||||
<li><strong>system_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – System name identifier.
|
||||
location and system name. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.appliance.recovery.html#com.vmware.appliance.recovery.backup_client.LocationSpec" title="com.vmware.appliance.recovery.backup_client.LocationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup_client.LocationSpec</span></code></a>) – LocationSpec Structure.</p></li>
|
||||
<li><p><strong>system_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – System name identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name</span></code>.</li>
|
||||
<li><strong>archive</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Archive identifier.
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name</span></code>.</p></li>
|
||||
<li><p><strong>archive</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Archive identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name.archive</span></code>.</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name.archive</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.Info" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Archive.Info</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Info Structure.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.Info" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Archive.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Info Structure.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if backup does not exist.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.Error</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if any error occurs during the execution of the operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -579,38 +576,34 @@ if any error occurs during the execution of the operation.</p>
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>loc_spec</em>, <em>system_name</em>, <em>filter_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about backup archives corresponding to given backup
|
||||
location and system name, which match the <a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Archive.FilterSpec</span></code></a>.
|
||||
This method was added in vSphere API 6.7</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>loc_spec</strong> (<a class="reference internal" href="com.vmware.appliance.recovery.html#com.vmware.appliance.recovery.backup_client.LocationSpec" title="com.vmware.appliance.recovery.backup_client.LocationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup_client.LocationSpec</span></code></a>) – LocationSpec Structure.</li>
|
||||
<li><strong>system_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – System name identifier.
|
||||
This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>loc_spec</strong> (<a class="reference internal" href="com.vmware.appliance.recovery.html#com.vmware.appliance.recovery.backup_client.LocationSpec" title="com.vmware.appliance.recovery.backup_client.LocationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup_client.LocationSpec</span></code></a>) – LocationSpec Structure.</p></li>
|
||||
<li><p><strong>system_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – System name identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name</span></code>.</li>
|
||||
<li><strong>filter_spec</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Archive.FilterSpec</span></code></a>) – Specification of matching backups for which information should be
|
||||
returned.</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name</span></code>.</p></li>
|
||||
<li><p><strong>filter_spec</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Archive.FilterSpec</span></code></a>) – Specification of matching backups for which information should be
|
||||
returned.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.list" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.Summary" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Archive.Summary</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Commonly used information about the backup archives.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.list" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.Summary" title="com.vmware.appliance.recovery.backup.system_name_client.Archive.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Archive.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Commonly used information about the backup archives.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if combination of <code class="docutils literal notranslate"><span class="pre">loc_spec</span></code> and system name does not refer to an
|
||||
existing location on the backup server.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.Error</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if any error occurs during the execution of the operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -620,14 +613,11 @@ if any error occurs during the execution of the operation.</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.backup.system_name_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.appliance.recovery.backup.system_name_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -644,7 +634,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
<a href="com.vmware.appliance.system.html" class="btn btn-neutral float-right" title="com.vmware.appliance.system package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.appliance.recovery.html" class="btn btn-neutral" title="com.vmware.appliance.recovery package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.appliance.recovery.html" class="btn btn-neutral float-left" title="com.vmware.appliance.recovery package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -653,7 +643,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -670,33 +660,16 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.appliance.system package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.appliance.system package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.cis package" href="com.vmware.cis.html" />
|
||||
<link rel="prev" title="com.vmware.appliance.recovery.backup package" href="com.vmware.appliance.recovery.backup.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -182,14 +185,11 @@
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.system.time_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.appliance.system.time_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -197,52 +197,47 @@
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.system.time_client.</code><code class="descname">Timezone</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.time_client.Timezone" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Timezone</span></code> class provides methods to get and set the appliance
|
||||
timezone. This class was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
timezone. This class was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.system.time_client.Timezone.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.time_client.Timezone.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get time zone. This method was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Time zone name.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
if timezone cannot be read.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dd><p>Get time zone. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Time zone name.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if timezone cannot be read.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.system.time_client.Timezone.set">
|
||||
<code class="descname">set</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.system.time_client.Timezone.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set time zone. This method was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Time zone name.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
||||
if passed arguments are invalid.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
if any error occurs during the execution of the operation.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dd><p>Set time zone. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Time zone name.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if passed arguments are invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if any error occurs during the execution of the operation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -261,7 +256,7 @@ if any error occurs during the execution of the operation.</td>
|
||||
<a href="com.vmware.cis.html" class="btn btn-neutral float-right" title="com.vmware.cis package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.appliance.recovery.backup.html" class="btn btn-neutral" title="com.vmware.appliance.recovery.backup package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.appliance.recovery.backup.html" class="btn btn-neutral float-left" title="com.vmware.appliance.recovery.backup package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -270,7 +265,7 @@ if any error occurs during the execution of the operation.</td>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -287,33 +282,16 @@ if any error occurs during the execution of the operation.</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
629
vsphere/cloud/com.vmware.content.type.html
Normal file
629
vsphere/cloud/com.vmware.content.type.html
Normal file
@ -0,0 +1,629 @@
|
||||
|
||||
|
||||
<!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>com.vmware.content.type package — vSphere Automation SDK for Python. 6.8.7 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" />
|
||||
<link rel="next" title="com.vmware.content.type.ovf package" href="com.vmware.content.type.ovf.html" />
|
||||
<link rel="prev" title="com.vmware.content.library.item package" href="com.vmware.content.library.item.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"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
</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 class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><a href="com.html">com package</a> »</li>
|
||||
|
||||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||||
|
||||
<li><a href="com.vmware.content.html">com.vmware.content package</a> »</li>
|
||||
|
||||
<li>com.vmware.content.type package</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/com.vmware.content.type.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="module-com.vmware.content.type">
|
||||
<span id="com-vmware-content-type-package"></span><h1>com.vmware.content.type package<a class="headerlink" href="#module-com.vmware.content.type" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="subpackages">
|
||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.content.type.ovf.html">com.vmware.content.type.ovf package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.type.ovf.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.type.ovf.html#module-com.vmware.content.type.ovf.policy_client">com.vmware.content.type.ovf.policy_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.content.type.ovf_client">
|
||||
<span id="com-vmware-content-type-ovf-client-module"></span><h2>com.vmware.content.type.ovf_client module<a class="headerlink" href="#module-com.vmware.content.type.ovf_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Cpu">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">Cpu</code><span class="sig-paren">(</span><em>num_cpus=None</em>, <em>reservation=None</em>, <em>limit=None</em>, <em>shares=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Cpu" 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>
|
||||
<p>Provide the CPU information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>num_cpus</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – number of CPUs</p></li>
|
||||
<li><p><strong>reservation</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>) – reservation in MHz
|
||||
It is optional to set a CPU reservation.</p></li>
|
||||
<li><p><strong>limit</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>) – CPU limit in MHz
|
||||
Is is optional to set a CPU limit.</p></li>
|
||||
<li><p><strong>shares</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>) – CPU shares
|
||||
It is optional to specify CPU shares.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Disk">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">Disk</code><span class="sig-paren">(</span><em>name=None</em>, <em>disk_capacity=None</em>, <em>storage_policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Disk" 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>
|
||||
<p>Provide the disk information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the disk</p></li>
|
||||
<li><p><strong>disk_capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Capacity of the disk in megabytes</p></li>
|
||||
<li><p><strong>storage_policy</strong> (<a class="reference internal" href="com.vmware.content.type.ovf.html#com.vmware.content.type.ovf.policy_client.StoragePolicy" title="com.vmware.content.type.ovf.policy_client.StoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.type.ovf.policy_client.StoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Storage policy of the disk.</p>
|
||||
<p>It is a reference to the storage policy group.
|
||||
It is not required that storage policy be specified.</p>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.DiskController">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">DiskController</code><span class="sig-paren">(</span><em>name=None</em>, <em>type=None</em>, <em>sub_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.DiskController" 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>
|
||||
<p>Provide the disk controller information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the disk controller</p></li>
|
||||
<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>) – Disk controller type: DiskControllerType.IDE.SATA.SCSI;
|
||||
It is optional to specify a disk controller type.</p></li>
|
||||
<li><p><strong>sub_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>) – Disk controller sub type: DiskControllerSubType
|
||||
It is optional to specify a disk controller subtype.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Drive">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">Drive</code><span class="sig-paren">(</span><em>name=None</em>, <em>type=None</em>, <em>sub_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Drive" 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>
|
||||
<p>Provide the drive information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the drive</p></li>
|
||||
<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>) – Drive type
|
||||
It is optional to specify a drive type.</p></li>
|
||||
<li><p><strong>sub_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>) – Drive sub type
|
||||
It is optional to specify a drive subtype.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Floppy">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">Floppy</code><span class="sig-paren">(</span><em>name=None</em>, <em>connected=None</em>, <em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Floppy" 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>
|
||||
<p>Provide the floppy information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the floppy</p></li>
|
||||
<li><p><strong>connected</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>) – True if floppy is connected
|
||||
It is optional to specify if a floppy is connected.</p></li>
|
||||
<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>) – Floppy type
|
||||
It is optional to specify the type of floppy drive.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Memory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">Memory</code><span class="sig-paren">(</span><em>size=None</em>, <em>reservation=None</em>, <em>limit=None</em>, <em>shares=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Memory" 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>
|
||||
<p>Provide the memory information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – memory size in MB</p></li>
|
||||
<li><p><strong>reservation</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>) – memory reservation in MB
|
||||
It is not required that memory reservation be specified.</p></li>
|
||||
<li><p><strong>limit</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>) – memory limit in MB
|
||||
It is not required that memory limit be specified.</p></li>
|
||||
<li><p><strong>shares</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>) – memory shares
|
||||
It is not required that memory shares be specified.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Network">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">Network</code><span class="sig-paren">(</span><em>name=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Network" 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>
|
||||
<p>Provide network information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the network</p></li>
|
||||
<li><p><strong>description</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>) – Description of the network
|
||||
Networks do not require a description.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.Nic">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">Nic</code><span class="sig-paren">(</span><em>name=None</em>, <em>network_name=None</em>, <em>mac_address=None</em>, <em>start_connected=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.Nic" 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>
|
||||
<p>Provide NIC information in a VM template</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of NIC</p></li>
|
||||
<li><p><strong>network_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>) – Name of the network that this NIC connects to
|
||||
It is not required that network name be specified.</p></li>
|
||||
<li><p><strong>mac_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>) – Mac address of this NIC
|
||||
It is not required that MAC address be specified.</p></li>
|
||||
<li><p><strong>start_connected</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>) – True if this nic will be connected on start.
|
||||
It is not required that whether the NIC is connected be specified.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.OvfTemplate">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">OvfTemplate</code><span class="sig-paren">(</span><em>id=None</em>, <em>vm_count=None</em>, <em>version=None</em>, <em>library_id_parent=None</em>, <em>is_vapp_template=None</em>, <em>vm_template=None</em>, <em>vapp_template=None</em>, <em>networks=None</em>, <em>storage_policy_groups=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.OvfTemplate" 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>
|
||||
<p>Provides extra information about a library item of type “ovf”.</p>
|
||||
<p>An OVF library item is the basic building block for instantiating virtual
|
||||
machines from content library. It may contain one or multiple virtual
|
||||
machine templates. This structure provides a rich view of the virtual
|
||||
machines within the ovf container as well as information about to the ovf
|
||||
descriptor associated with the library item</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Library item id.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
|
||||
this class as a return value, the attribute will be an identifier
|
||||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
|
||||
<li><p><strong>vm_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of virtual machines in the the ovf template.</p></li>
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>A version number indicating the generation of the <code class="docutils literal notranslate"><span class="pre">OvfTemplate</span></code></p>
|
||||
<p>This value is incremented every time <code class="docutils literal notranslate"><span class="pre">OvfTemplate</span></code> changes.</p>
|
||||
</p></li>
|
||||
<li><p><strong>library_id_parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the
|
||||
<a class="reference internal" href="com.vmware.html#com.vmware.content_client.LibraryModel" title="com.vmware.content_client.LibraryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content_client.LibraryModel</span></code></a> to which this item
|
||||
belongs. This is used to set the parent of the ovf template for
|
||||
permission propagation.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p></li>
|
||||
<li><p><strong>is_vapp_template</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – True if this is a vApp template, otherwise this is a VM template.</p></li>
|
||||
<li><p><strong>vm_template</strong> (<a class="reference internal" href="#com.vmware.content.type.ovf_client.VmTemplate" title="com.vmware.content.type.ovf_client.VmTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmTemplate</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The Vitrual Machine if this is a VM template
|
||||
An OVF template does not require a VM template.</p></li>
|
||||
<li><p><strong>vapp_template</strong> (<a class="reference internal" href="#com.vmware.content.type.ovf_client.VAppTemplate" title="com.vmware.content.type.ovf_client.VAppTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">VAppTemplate</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The root VApp template in this OVF template if this is a vApp
|
||||
template
|
||||
An OVF template does not require a vApp template.</p></li>
|
||||
<li><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.Network" title="com.vmware.content.type.ovf_client.Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network</span></code></a>) – networks in this OVF template</p></li>
|
||||
<li><p><strong>storage_policy_groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.content.type.ovf.html#com.vmware.content.type.ovf.policy_client.StoragePolicyGroup" title="com.vmware.content.type.ovf.policy_client.StoragePolicyGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.type.ovf.policy_client.StoragePolicyGroup</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage policy groups for disks, virtual machines and/or virtual
|
||||
machine collections.
|
||||
An OVF template does not require policies.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_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.content.type.ovf_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.USBController">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">USBController</code><span class="sig-paren">(</span><em>type=None</em>, <em>auto_connect=None</em>, <em>ehci_pci_slot_number=None</em>, <em>pci_slot_number=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.USBController" 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>
|
||||
<p>Provide USB controller information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<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>) – USBControllerType.EHCI (USB 2.0), XHCI (USB 3.0)
|
||||
A template is not required to specify the USB type.</p></li>
|
||||
<li><p><strong>auto_connect</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>) – True if the USB controller is connected automatically
|
||||
A template is not required to specify if auto connect.</p></li>
|
||||
<li><p><strong>ehci_pci_slot_number</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>) – ehci.pci slot number
|
||||
A template is not required to specify the ehci.pci slot number.</p></li>
|
||||
<li><p><strong>pci_slot_number</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>) – pci slot number
|
||||
A template is not required to specify the pci slot number.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.VAppTemplate">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">VAppTemplate</code><span class="sig-paren">(</span><em>vapp_name=None</em>, <em>vm_templates=None</em>, <em>storage_policies=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.VAppTemplate" 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>
|
||||
<p>Provide information for vApp template in an OVF template file.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vapp_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>) – Name of the vApp template
|
||||
vApp templates do not require a name.</p></li>
|
||||
<li><p><strong>vm_templates</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.VmTemplate" title="com.vmware.content.type.ovf_client.VmTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmTemplate</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Vitrual Machines in this vApp template
|
||||
vApp templates do not require a list of VM templates.</p></li>
|
||||
<li><p><strong>storage_policies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.content.type.ovf.html#com.vmware.content.type.ovf.policy_client.StoragePolicy" title="com.vmware.content.type.ovf.policy_client.StoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.type.ovf.policy_client.StoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage policies of the vApp template.
|
||||
vApp templates do not require a list of storage policies.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.VideoCard">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">VideoCard</code><span class="sig-paren">(</span><em>render_type=None</em>, <em>video_ram_size=None</em>, <em>graphics_memory_size=None</em>, <em>enable3d=None</em>, <em>num_displays=None</em>, <em>use_auto_detect=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.VideoCard" 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>
|
||||
<p>Provide video card information in a template VM.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>render_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>) – Render type
|
||||
A template is not required to specify the render type.</p></li>
|
||||
<li><p><strong>video_ram_size</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>) – video RAM size in KB
|
||||
A template is not required to specify the video RAM.</p></li>
|
||||
<li><p><strong>graphics_memory_size</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>) – graphics memory size in KB
|
||||
A template is not required to specify the amount of graphics
|
||||
memory.</p></li>
|
||||
<li><p><strong>enable3d</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>) – True if 3D is enabled
|
||||
A template is not required to specify if 3D is enabled.</p></li>
|
||||
<li><p><strong>num_displays</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>) – number of displayes
|
||||
A template is not required to specify the number of displays.</p></li>
|
||||
<li><p><strong>use_auto_detect</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>) – True if use auto detect
|
||||
A template is not required to specify use auto dectect.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf_client.VmTemplate">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf_client.</code><code class="descname">VmTemplate</code><span class="sig-paren">(</span><em>vm_name=None</em>, <em>os_type=None</em>, <em>os_description=None</em>, <em>cpu=None</em>, <em>memory=None</em>, <em>disks=None</em>, <em>nics=None</em>, <em>video_cards=None</em>, <em>drives=None</em>, <em>floppies=None</em>, <em>disk_controllers=None</em>, <em>usb_controllers=None</em>, <em>storage_policies=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf_client.VmTemplate" 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>
|
||||
<p>Provide template VM information in an OVF template (see OvfTemplate#type).
|
||||
The template VM provide the information about the operation system, CPU,
|
||||
memory, disks and NICs.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the VM</p></li>
|
||||
<li><p><strong>os_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>) – OS type of the VM
|
||||
A VM template is not required to specify an OS.</p></li>
|
||||
<li><p><strong>os_description</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>) – OS description
|
||||
A VM template is not required to specify an OS.</p></li>
|
||||
<li><p><strong>cpu</strong> (<a class="reference internal" href="#com.vmware.content.type.ovf_client.Cpu" title="com.vmware.content.type.ovf_client.Cpu"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cpu</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – CPU information of the VM
|
||||
A VM template is not required to specify a CPU.</p></li>
|
||||
<li><p><strong>memory</strong> (<a class="reference internal" href="#com.vmware.content.type.ovf_client.Memory" title="com.vmware.content.type.ovf_client.Memory"><code class="xref py py-class docutils literal notranslate"><span class="pre">Memory</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – memory information of the VM
|
||||
A VM template is not required to specify memory.</p></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.content.type.ovf_client.Disk" title="com.vmware.content.type.ovf_client.Disk"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – All hard disks on the VM
|
||||
A VM template is not required to specify a list of disks.</p></li>
|
||||
<li><p><strong>nics</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.Nic" title="com.vmware.content.type.ovf_client.Nic"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – All NICs on the VM
|
||||
A VM template is not required to specify a list of network
|
||||
interfaces.</p></li>
|
||||
<li><p><strong>video_cards</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.VideoCard" title="com.vmware.content.type.ovf_client.VideoCard"><code class="xref py py-class docutils literal notranslate"><span class="pre">VideoCard</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Video cards of the VM
|
||||
A VM template is not required to specify a list of video cards.</p></li>
|
||||
<li><p><strong>drives</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.Drive" title="com.vmware.content.type.ovf_client.Drive"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drive</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – CD / DVD drives of the VM
|
||||
A VM template is not required to specify a list of drives.</p></li>
|
||||
<li><p><strong>floppies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.Floppy" title="com.vmware.content.type.ovf_client.Floppy"><code class="xref py py-class docutils literal notranslate"><span class="pre">Floppy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – floppy drives of the VM
|
||||
A VM template is not required to specify a list of floppy drives.</p></li>
|
||||
<li><p><strong>disk_controllers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.DiskController" title="com.vmware.content.type.ovf_client.DiskController"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiskController</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Disk Controllers
|
||||
A VM template is not required to specify a list of disk
|
||||
controllers.</p></li>
|
||||
<li><p><strong>usb_controllers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.content.type.ovf_client.USBController" title="com.vmware.content.type.ovf_client.USBController"><code class="xref py py-class docutils literal notranslate"><span class="pre">USBController</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – USB Controllers
|
||||
A VM template is not required to specify a list of USB controllers.</p></li>
|
||||
<li><p><strong>storage_policies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.content.type.ovf.html#com.vmware.content.type.ovf.policy_client.StoragePolicy" title="com.vmware.content.type.ovf.policy_client.StoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.type.ovf.policy_client.StoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage policies of the VM.
|
||||
A VM template is not required to specify a list of storage
|
||||
policies.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="com.vmware.content.type.ovf.html" class="btn btn-neutral float-right" title="com.vmware.content.type.ovf package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.content.library.item.html" class="btn btn-neutral float-left" title="com.vmware.content.library.item package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<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>
|
||||
290
vsphere/cloud/com.vmware.content.type.ovf.html
Normal file
290
vsphere/cloud/com.vmware.content.type.ovf.html
Normal file
@ -0,0 +1,290 @@
|
||||
|
||||
|
||||
<!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>com.vmware.content.type.ovf package — vSphere Automation SDK for Python. 6.8.7 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" />
|
||||
<link rel="next" title="com.vmware.vapi package" href="com.vmware.vapi.html" />
|
||||
<link rel="prev" title="com.vmware.content.type package" href="com.vmware.content.type.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"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
</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 class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><a href="com.html">com package</a> »</li>
|
||||
|
||||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||||
|
||||
<li><a href="com.vmware.content.html">com.vmware.content package</a> »</li>
|
||||
|
||||
<li><a href="com.vmware.content.type.html">com.vmware.content.type package</a> »</li>
|
||||
|
||||
<li>com.vmware.content.type.ovf package</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/com.vmware.content.type.ovf.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="module-com.vmware.content.type.ovf">
|
||||
<span id="com-vmware-content-type-ovf-package"></span><h1>com.vmware.content.type.ovf package<a class="headerlink" href="#module-com.vmware.content.type.ovf" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.content.type.ovf.policy_client">
|
||||
<span id="com-vmware-content-type-ovf-policy-client-module"></span><h2>com.vmware.content.type.ovf.policy_client module<a class="headerlink" href="#module-com.vmware.content.type.ovf.policy_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf.policy_client.StoragePolicy">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf.policy_client.</code><code class="descname">StoragePolicy</code><span class="sig-paren">(</span><em>group_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf.policy_client.StoragePolicy" 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>
|
||||
<p>Provide information of the membership of a particular storage policy group.</p>
|
||||
<p>It is valid for disk, virtual machine or virtual machine collection.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id reference of the particular storage policy group.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf.policy_client.StoragePolicyGroup">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf.policy_client.</code><code class="descname">StoragePolicyGroup</code><span class="sig-paren">(</span><em>id=None</em>, <em>name=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.type.ovf.policy_client.StoragePolicyGroup" 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>
|
||||
<p>Provide information of storage policy for a group of disks, virtual
|
||||
machines and/or virtual machine collections.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id of the policy</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy</p></li>
|
||||
<li><p><strong>description</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>) – Description of the policy
|
||||
Description is not required.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.type.ovf.policy_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.type.ovf.policy_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.content.type.ovf.policy_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="com.vmware.vapi.html" class="btn btn-neutral float-right" title="com.vmware.vapi package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.content.type.html" class="btn btn-neutral float-left" title="com.vmware.content.type package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<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>
|
||||
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vapi package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vapi package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -29,11 +36,7 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vapi.metadata package" href="com.vmware.vapi.metadata.html" />
|
||||
<link rel="prev" title="com.vmware.content.library.item package" href="com.vmware.content.library.item.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
<link rel="prev" title="com.vmware.content.type.ovf package" href="com.vmware.content.type.ovf.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -201,12 +204,137 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.privilege_client">com.vmware.vapi.metadata.privilege_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vapi.std.html">com.vmware.vapi.std package</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vapi.std.html">com.vmware.vapi.std package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.errors_client">com.vmware.vapi.std.errors_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vapi.metadata_client">
|
||||
<span id="com-vmware-vapi-metadata-client-module"></span><h2>com.vmware.vapi.metadata_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <a class="reference internal" href="#module-com.vmware.vapi.metadata_client" title="com.vmware.vapi.metadata_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata_client</span></code></a> module provides metadata classes.
|
||||
These are classes that provide different facets of API information. Clients can
|
||||
use these classes to:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Discover APIs available in the infrastructure.</p></li>
|
||||
<li><p>Fetch metadata that can be used to build presentation layers like CLI, REST,
|
||||
etc.</p></li>
|
||||
<li><p>Fetch authentication and authorization metadata.</p></li>
|
||||
</ul>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.metadata_client.SourceCreateSpec">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata_client.</code><code class="descname">SourceCreateSpec</code><span class="sig-paren">(</span><em>description=None</em>, <em>type=None</em>, <em>filepath=None</em>, <em>address=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceCreateSpec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">SourceCreateSpec</span></code> class contains the registration information for a
|
||||
metadata source.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – English language human readable description of the source.</p></li>
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType" title="com.vmware.vapi.metadata_client.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code></a>) – Type of the metadata source.</p></li>
|
||||
<li><p><strong>filepath</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute file path of the metamodel metadata file that has the
|
||||
metamodel information about one component element.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.FILE" title="com.vmware.vapi.metadata_client.SourceType.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.FILE</span></code></a>.</p></li>
|
||||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Connection information of the remote server. This should be of the
|
||||
format http(s)://IP:port/namespace.</p>
|
||||
<p>The remote server should contain the classes in
|
||||
<a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.metamodel_client" title="com.vmware.vapi.metadata.metamodel_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client</span></code></a> module. It could
|
||||
expose metamodel information of one or more components.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.REMOTE" title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.REMOTE</span></code></a>.</p>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.metadata_client.SourceInfo">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata_client.</code><code class="descname">SourceInfo</code><span class="sig-paren">(</span><em>type=None</em>, <em>file_name=None</em>, <em>remote_addr=None</em>, <em>msg_protocol=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceInfo" 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>
|
||||
<p>Metadata source info</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType" title="com.vmware.vapi.metadata_client.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code></a>) – Type of the metadata source</p></li>
|
||||
<li><p><strong>file_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the metadata source file
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.FILE" title="com.vmware.vapi.metadata_client.SourceType.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.FILE</span></code></a>.</p></li>
|
||||
<li><p><strong>remote_addr</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Address of the remote metadata source
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.REMOTE" title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.REMOTE</span></code></a>.</p></li>
|
||||
<li><p><strong>msg_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Message protocol to be used
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.REMOTE" title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.REMOTE</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.metadata_client.SourceType">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata_client.</code><code class="descname">SourceType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceType" 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.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">SourceType</span></code> class defines the types of sources for API metadata. You
|
||||
specify the type of source when adding a metadata source to a metadata
|
||||
service.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. 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 the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType" title="com.vmware.vapi.metadata_client.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code></a> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.metadata_client.SourceType.FILE">
|
||||
<code class="descname">FILE</code><em class="property"> = SourceType(string='FILE')</em><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceType.FILE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates the metadata source is a JSON file.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.metadata_client.SourceType.REMOTE">
|
||||
<code class="descname">REMOTE</code><em class="property"> = SourceType(string='REMOTE')</em><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceType.REMOTE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates the metadata source is a remote server.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.metadata_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata_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.vapi.metadata_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vapi.std_client">
|
||||
<span id="com-vmware-vapi-std-client-module"></span><h2>com.vmware.vapi.std_client module<a class="headerlink" href="#module-com.vmware.vapi.std_client" title="Permalink to this headline">¶</a></h2>
|
||||
@ -222,8 +350,8 @@ the vAPI infrastructure shipped by VMware.</p>
|
||||
<p>A third party extension can define and implements it’s own authentication
|
||||
mechanism and define a constant in a different IDL file.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="attribute">
|
||||
@ -240,12 +368,13 @@ authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
SecurityContext structure in the execution context of the request:</p>
|
||||
<ul class="simple">
|
||||
<li>The scheme identifier - com.vmware.vapi.std.security.oauth</li>
|
||||
<li>Valid OAuth2 access token - This is usually acquired by OAuth2 Authorization
|
||||
Server after successful authentication of the end user.</li>
|
||||
<li><p>The scheme identifier - com.vmware.vapi.std.security.oauth</p></li>
|
||||
<li><p>Valid OAuth2 access token - This is usually acquired by OAuth2 Authorization
|
||||
Server after successful authentication of the end user.</p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div>Sample security context in JSON format that matches the specification: <a href="#id1"><span class="problematic" id="id2">``</span></a>{</div></blockquote>
|
||||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id1"><span class="problematic" id="id2">``</span></a>{</p>
|
||||
</div></blockquote>
|
||||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.oauth’,
|
||||
‘accesstoken’: ….
|
||||
}``
|
||||
@ -262,11 +391,12 @@ based authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
SecurityContext structure in the execution context of the request:</p>
|
||||
<ul class="simple">
|
||||
<li>The scheme identifier: com.vmware.vapi.std.security.saml_bearer_token</li>
|
||||
<li>The token itself</li>
|
||||
<li><p>The scheme identifier: com.vmware.vapi.std.security.saml_bearer_token</p></li>
|
||||
<li><p>The token itself</p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div>Sample security context in JSON format that matches the specification: <a href="#id3"><span class="problematic" id="id4">``</span></a>{</div></blockquote>
|
||||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id3"><span class="problematic" id="id4">``</span></a>{</p>
|
||||
</div></blockquote>
|
||||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.saml_bearer_token’,
|
||||
‘token’: ‘the token itself’
|
||||
}`` vAPI runtime provide convenient factory methods that take SAML bearer token
|
||||
@ -281,15 +411,16 @@ token based authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
SecurityContext structure in the execution context of the request:</p>
|
||||
<ul class="simple">
|
||||
<li>The scheme identifier: com.vmware.vapi.std.security.saml_hok_token</li>
|
||||
<li>Signature of the request: This includes - algorithm used for signing the
|
||||
request, SAML holder of key token and signature digest</li>
|
||||
<li>Request timestamp: This includes the <code class="docutils literal notranslate"><span class="pre">created</span></code> and <code class="docutils literal notranslate"><span class="pre">expires</span></code> timestamp of
|
||||
<li><p>The scheme identifier: com.vmware.vapi.std.security.saml_hok_token</p></li>
|
||||
<li><p>Signature of the request: This includes - algorithm used for signing the
|
||||
request, SAML holder of key token and signature digest</p></li>
|
||||
<li><p>Request timestamp: This includes the <code class="docutils literal notranslate"><span class="pre">created</span></code> and <code class="docutils literal notranslate"><span class="pre">expires</span></code> timestamp of
|
||||
the request. The timestamp should match the following format -
|
||||
YYYY-MM-DDThh:mm:ss.sssZ (e.g. 1878-03-03T19:20:30.451Z).</li>
|
||||
YYYY-MM-DDThh:mm:ss.sssZ (e.g. 1878-03-03T19:20:30.451Z).</p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div>Sample security context in JSON format that matches the specification: <a href="#id5"><span class="problematic" id="id6">``</span></a>{</div></blockquote>
|
||||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id5"><span class="problematic" id="id6">``</span></a>{</p>
|
||||
</div></blockquote>
|
||||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.saml_hok_token’,
|
||||
‘signature’: {
|
||||
‘alg’: ‘RS256’,
|
||||
@ -308,13 +439,14 @@ based authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
SecurityContext structure in the execution context of the request:</p>
|
||||
<ul class="simple">
|
||||
<li>The scheme identifier - com.vmware.vapi.std.security.session_id</li>
|
||||
<li>Valid session identifier - This is usually returned by a login method of a
|
||||
<li><p>The scheme identifier - com.vmware.vapi.std.security.session_id</p></li>
|
||||
<li><p>Valid session identifier - This is usually returned by a login method of a
|
||||
session manager interface for a particular vAPI service of this authentication
|
||||
scheme</li>
|
||||
scheme</p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div>Sample security context in JSON format that matches the specification: <a href="#id7"><span class="problematic" id="id8">``</span></a>{</div></blockquote>
|
||||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id7"><span class="problematic" id="id8">``</span></a>{</p>
|
||||
</div></blockquote>
|
||||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.session_id’,
|
||||
‘sessionId’: ….,
|
||||
}`` vAPI runtime provides convenient factory methods that take session
|
||||
@ -330,12 +462,13 @@ based authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
SecurityContext structure in the execution context of the request:</p>
|
||||
<ul class="simple">
|
||||
<li>The scheme identifier - com.vmware.vapi.std.security.user_pass</li>
|
||||
<li>Username</li>
|
||||
<li>Password</li>
|
||||
<li><p>The scheme identifier - com.vmware.vapi.std.security.user_pass</p></li>
|
||||
<li><p>Username</p></li>
|
||||
<li><p>Password</p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div>Sample security context in JSON format that matches the specification: <a href="#id9"><span class="problematic" id="id10">``</span></a>{</div></blockquote>
|
||||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id9"><span class="problematic" id="id10">``</span></a>{</p>
|
||||
</div></blockquote>
|
||||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.user_pass’,
|
||||
‘userName’: ….,
|
||||
‘password’: …
|
||||
@ -354,73 +487,67 @@ above format.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">DynamicID</span></code> class represents an identifier for a resource of an
|
||||
arbitrary type.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The type of resource being identified (for example
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The type of resource being identified (for example
|
||||
<code class="docutils literal notranslate"><span class="pre">com.acme.Person</span></code>).</p>
|
||||
<p>Classes that contain methods for creating and deleting resources
|
||||
typically contain a class attribute specifying the resource type
|
||||
for the resources being created and deleted. The API metamodel
|
||||
metadata classes include a class that allows retrieving all the
|
||||
known resource types.</p>
|
||||
</li>
|
||||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier for a resource whose type is specified by
|
||||
</p></li>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier for a resource whose type is specified by
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">DynamicID.type</span></code>.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute <code class="docutils literal notranslate"><span class="pre">type</span></code> must contain the actual resource type. When
|
||||
methods return a value of this class as a return value, the
|
||||
attribute <code class="docutils literal notranslate"><span class="pre">type</span></code> will contain the actual resource type.</li>
|
||||
attribute <code class="docutils literal notranslate"><span class="pre">type</span></code> will contain the actual resource type.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std_client.LocalizableMessage">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.std_client.</code><code class="descname">LocalizableMessage</code><span class="sig-paren">(</span><em>id=None</em>, <em>default_message=None</em>, <em>args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizableMessage" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">LocalizableMessage</span></code> class represents a localizable string or message
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">LocalizableMessage</span></code> class represents localizable string and message
|
||||
template. Classes include one or more localizable message templates in the
|
||||
exceptions they report so that clients can display diagnostic messages in
|
||||
the native language of the user. Classes can include localizable strings in
|
||||
the data returned from methods to allow clients to display localized status
|
||||
information in the native language of the user.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Unique identifier of the localizable string or message template.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Unique identifier of the localizable string or message template.</p>
|
||||
<p>This identifier is typically used to retrieve a locale-specific
|
||||
string or message template from a message catalog.</p>
|
||||
</li>
|
||||
<li><strong>default_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The value of this localizable string or message template in the
|
||||
</p></li>
|
||||
<li><p><strong>default_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The value of this localizable string or message template in the
|
||||
<code class="docutils literal notranslate"><span class="pre">en_US</span></code> (English) locale. If <code class="xref py py-attr docutils literal notranslate"><span class="pre">LocalizableMessage.id</span></code> refers
|
||||
to a message template, the default message will contain the
|
||||
substituted arguments. This value can be used by clients that do
|
||||
not need to display strings and messages in the native language of
|
||||
the user. It could also be used as a fallback if a client is unable
|
||||
to access the appropriate message catalog.</li>
|
||||
<li><strong>args</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>) – Arguments to be substituted into a message template.</li>
|
||||
to access the appropriate message catalog.</p></li>
|
||||
<li><p><strong>args</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>) – Positional arguments to be substituted into the message template.
|
||||
This list will be empty if the message uses named arguments or has
|
||||
no arguments.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -428,14 +555,11 @@ to access the appropriate message catalog.</li>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.std_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.vapi.std_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -452,7 +576,7 @@ to access the appropriate message catalog.</li>
|
||||
<a href="com.vmware.vapi.metadata.html" class="btn btn-neutral float-right" title="com.vmware.vapi.metadata package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.content.library.item.html" class="btn btn-neutral" title="com.vmware.content.library.item package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.content.type.ovf.html" class="btn btn-neutral float-left" title="com.vmware.content.type.ovf package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -461,7 +585,7 @@ to access the appropriate message catalog.</li>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -478,33 +602,16 @@ to access the appropriate message catalog.</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vapi.metadata.authentication package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vapi.metadata.authentication package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vapi.metadata.metamodel package" href="com.vmware.vapi.metadata.metamodel.html" />
|
||||
<link rel="prev" title="com.vmware.vapi.metadata package" href="com.vmware.vapi.metadata.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -189,14 +192,11 @@ classes to retrieve authentication information for operation elements.</p>
|
||||
information of an operation element.</p>
|
||||
<p>An operation element is said to contain authentication information if
|
||||
authentication schemes are specified in the authentication definition file.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.metadata.authentication.service_client.Operation.RESOURCE_TYPE">
|
||||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.operation'</em><a class="headerlink" href="#com.vmware.vapi.metadata.authentication.service_client.Operation.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
@ -209,45 +209,41 @@ authentication schemes are specified in the authentication definition file.</p>
|
||||
<dd><p>Retrieves the authentication information about an operation element
|
||||
corresponding to <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> contained in the service element
|
||||
corresponding to <code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</li>
|
||||
<li><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation element.
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||||
<li><p><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.authentication_client.OperationInfo" title="com.vmware.vapi.metadata.authentication_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.authentication_client.OperationInfo</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.authentication_client.OperationInfo" title="com.vmware.vapi.metadata.authentication_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.authentication_client.OperationInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The
|
||||
<a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.authentication_client.OperationInfo" title="com.vmware.vapi.metadata.authentication_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.authentication_client.OperationInfo</span></code></a>
|
||||
instance that corresponds to <code class="docutils literal notranslate"><span class="pre">operation_id</span></code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not
|
||||
exist.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the operation element associated with <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> does not
|
||||
exist.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the operation element associated with <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> does not
|
||||
have any authentication information.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -256,27 +252,27 @@ have any authentication information.</p>
|
||||
<dd><p>Returns the identifiers for the operation elements contained in the
|
||||
service element corresponding to <code class="docutils literal notranslate"><span class="pre">service_id</span></code> that have
|
||||
authentication information.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vapi.metadata.authentication.service_client.Operation.list" title="com.vmware.vapi.metadata.authentication.service_client.Operation.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of identifiers for the operation elements contained in the
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.authentication.service_client.Operation.list" title="com.vmware.vapi.metadata.authentication.service_client.Operation.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>List of identifiers for the operation elements contained in the
|
||||
service element that have authentication information.
|
||||
The return value will contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not have
|
||||
any operation elements that have authentication information.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
any operation elements that have authentication information.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -286,14 +282,11 @@ any operation elements that have authentication information.</td>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.authentication.service_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.vapi.metadata.authentication.service_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -310,7 +303,7 @@ any operation elements that have authentication information.</td>
|
||||
<a href="com.vmware.vapi.metadata.metamodel.html" class="btn btn-neutral float-right" title="com.vmware.vapi.metadata.metamodel package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vapi.metadata.html" class="btn btn-neutral" title="com.vmware.vapi.metadata package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vapi.metadata.html" class="btn btn-neutral float-left" title="com.vmware.vapi.metadata package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -319,7 +312,7 @@ any operation elements that have authentication information.</td>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -336,33 +329,16 @@ any operation elements that have authentication information.</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vapi.metadata.metamodel package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vapi.metadata.metamodel package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vapi.metadata.privilege package" href="com.vmware.vapi.metadata.privilege.html" />
|
||||
<link rel="prev" title="com.vmware.vapi.metadata.authentication package" href="com.vmware.vapi.metadata.authentication.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -193,14 +196,11 @@ creating indexes for querying.</p>
|
||||
services can provide the model structure for an entity of this resource
|
||||
type. Using <code class="docutils literal notranslate"><span class="pre">Model</span></code> class you can retrieve the list of all the structure
|
||||
elements that are model structures for a given resource type.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.resource_client.Model.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>resource_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.resource_client.Model.list" title="Permalink to this definition">¶</a></dt>
|
||||
@ -209,27 +209,27 @@ models for the resource type corresponding to <code class="docutils literal notr
|
||||
<p>The <a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.metamodel_client.Structure" title="com.vmware.vapi.metadata.metamodel_client.Structure"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client.Structure</span></code></a> class
|
||||
provides methods to retrieve more details about the structure elements
|
||||
corresponding to the identifiers returned by this method.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>resource_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the resource type.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>resource_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the resource type.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The set of identifiers for the models that are associated with the
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The set of identifiers for the models that are associated with the
|
||||
resource type in <code class="docutils literal notranslate"><span class="pre">resource_id</span></code>.
|
||||
The return value will contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the resource type associated with <code class="docutils literal notranslate"><span class="pre">resource_id</span></code> does not
|
||||
exist.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
exist.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -239,14 +239,11 @@ exist.</td>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel.resource_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.vapi.metadata.metamodel.resource_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -258,14 +255,11 @@ exist.</td>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Operation</span></code> class provides methods to retrieve metamodel information
|
||||
of an operation element in the interface definition language.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.service_client.Operation.RESOURCE_TYPE">
|
||||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.operation'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
@ -278,41 +272,37 @@ of an operation element in the interface definition language.</p>
|
||||
<dd><p>Retrieves the metamodel information about an operation element
|
||||
corresponding to <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> contained in the service element
|
||||
corresponding to <code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</li>
|
||||
<li><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation element.
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||||
<li><p><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.metamodel_client.OperationInfo" title="com.vmware.vapi.metadata.metamodel_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client.OperationInfo</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.metamodel_client.OperationInfo" title="com.vmware.vapi.metadata.metamodel_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client.OperationInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The
|
||||
<a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.metamodel_client.OperationInfo" title="com.vmware.vapi.metadata.metamodel_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client.OperationInfo</span></code></a>
|
||||
instance that corresponds to <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> defined in scope
|
||||
<code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not
|
||||
exist in any of the package elements.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the operation element associated with <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> does not
|
||||
exist in the service element.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -320,27 +310,27 @@ exist in the service element.</p>
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the identifiers for the operation elements that are defined in
|
||||
the scope of <code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation.list" title="com.vmware.vapi.metadata.metamodel.service_client.Operation.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The list of identifiers for the operation elements that are defined
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation.list" title="com.vmware.vapi.metadata.metamodel.service_client.Operation.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The list of identifiers for the operation elements that are defined
|
||||
in the scope of <code class="docutils literal notranslate"><span class="pre">service_id</span></code>.
|
||||
The return value will contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not
|
||||
exist in any of the package elements.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
exist in any of the package elements.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -350,14 +340,11 @@ exist in any of the package elements.</td>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel.service_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.vapi.metadata.metamodel.service_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -374,7 +361,7 @@ exist in any of the package elements.</td>
|
||||
<a href="com.vmware.vapi.metadata.privilege.html" class="btn btn-neutral float-right" title="com.vmware.vapi.metadata.privilege package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vapi.metadata.authentication.html" class="btn btn-neutral" title="com.vmware.vapi.metadata.authentication package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vapi.metadata.authentication.html" class="btn btn-neutral float-left" title="com.vmware.vapi.metadata.authentication package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -383,7 +370,7 @@ exist in any of the package elements.</td>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -400,33 +387,16 @@ exist in any of the package elements.</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vapi.metadata.privilege package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vapi.metadata.privilege package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vapi.std package" href="com.vmware.vapi.std.html" />
|
||||
<link rel="prev" title="com.vmware.vapi.metadata.metamodel package" href="com.vmware.vapi.metadata.metamodel.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -191,14 +194,11 @@ of an operation element.</p>
|
||||
any privileges assigned to the operation element or if one of the parameter
|
||||
elements contained in it has privileges assigned in privilege definition
|
||||
file.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.metadata.privilege.service_client.Operation.RESOURCE_TYPE">
|
||||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.operation'</em><a class="headerlink" href="#com.vmware.vapi.metadata.privilege.service_client.Operation.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
@ -211,45 +211,41 @@ file.</p>
|
||||
<dd><p>Retrieves the privilege information about an operation element
|
||||
corresponding to <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> contained in the service element
|
||||
corresponding to <code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</li>
|
||||
<li><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation element.
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||||
<li><p><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.privilege_client.OperationInfo" title="com.vmware.vapi.metadata.privilege_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.privilege_client.OperationInfo</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.privilege_client.OperationInfo" title="com.vmware.vapi.metadata.privilege_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.privilege_client.OperationInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The
|
||||
<a class="reference internal" href="com.vmware.vapi.metadata.html#com.vmware.vapi.metadata.privilege_client.OperationInfo" title="com.vmware.vapi.metadata.privilege_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.privilege_client.OperationInfo</span></code></a>
|
||||
instance that corresponds to <code class="docutils literal notranslate"><span class="pre">operation_id</span></code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not
|
||||
exist.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the operation element associated with <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> does not
|
||||
exist.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the operation element associated with <code class="docutils literal notranslate"><span class="pre">operation_id</span></code> does not
|
||||
have any privilege information.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -258,27 +254,27 @@ have any privilege information.</p>
|
||||
<dd><p>Returns the identifiers for the operation elements contained in the
|
||||
service element corresponding to <code class="docutils literal notranslate"><span class="pre">service_id</span></code> that have privilege
|
||||
information.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vapi.metadata.privilege.service_client.Operation.list" title="com.vmware.vapi.metadata.privilege.service_client.Operation.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of identifiers for the operation elements contained in the
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.privilege.service_client.Operation.list" title="com.vmware.vapi.metadata.privilege.service_client.Operation.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>List of identifiers for the operation elements contained in the
|
||||
service element that have privilege information.
|
||||
The return value will contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not have
|
||||
any operation elements that have privilege information.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
any operation elements that have privilege information.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -288,14 +284,11 @@ any operation elements that have privilege information.</td>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.privilege.service_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.vapi.metadata.privilege.service_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -312,7 +305,7 @@ any operation elements that have privilege information.</td>
|
||||
<a href="com.vmware.vapi.std.html" class="btn btn-neutral float-right" title="com.vmware.vapi.std package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vapi.metadata.metamodel.html" class="btn btn-neutral" title="com.vmware.vapi.metadata.metamodel package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vapi.metadata.metamodel.html" class="btn btn-neutral float-left" title="com.vmware.vapi.metadata.metamodel package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -321,7 +314,7 @@ any operation elements that have privilege information.</td>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -338,33 +331,16 @@ any operation elements that have privilege information.</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
742
vsphere/cloud/com.vmware.vcenter.certificate_management.html
Normal file
742
vsphere/cloud/com.vmware.vcenter.certificate_management.html
Normal file
@ -0,0 +1,742 @@
|
||||
|
||||
|
||||
<!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>com.vmware.vcenter.certificate_management package — vSphere Automation SDK for Python. 6.8.7 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" />
|
||||
<link rel="next" title="com.vmware.vcenter.compute package" href="com.vmware.vcenter.compute.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter package" href="com.vmware.vcenter.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"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
</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 class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><a href="com.html">com package</a> »</li>
|
||||
|
||||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||||
|
||||
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> »</li>
|
||||
|
||||
<li>com.vmware.vcenter.certificate_management package</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/com.vmware.vcenter.certificate_management.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="module-com.vmware.vcenter.certificate_management">
|
||||
<span id="com-vmware-vcenter-certificate-management-package"></span><h1>com.vmware.vcenter.certificate_management package<a class="headerlink" href="#module-com.vmware.vcenter.certificate_management" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vcenter.certificate_management.vcenter_client">
|
||||
<span id="com-vmware-vcenter-certificate-management-vcenter-client-module"></span><h2>com.vmware.vcenter.certificate_management.vcenter_client module<a class="headerlink" href="#module-com.vmware.vcenter.certificate_management.vcenter_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.certificate_management.vcenter_client</span></code> module
|
||||
provides classes to manage certificates.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.certificate_management.vcenter_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.vcenter.certificate_management.vcenter_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="descname">Tls</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Tls</span></code> interface provides methods to replace Tls certificate. This
|
||||
class was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>version=None</em>, <em>serial_number=None</em>, <em>signature_algorithm=None</em>, <em>issuer_dn=None</em>, <em>valid_from=None</em>, <em>valid_to=None</em>, <em>subject_dn=None</em>, <em>thumbprint=None</em>, <em>is_ca=None</em>, <em>path_length_constraint=None</em>, <em>key_usage=None</em>, <em>extended_key_usage=None</em>, <em>subject_alternative_name=None</em>, <em>authority_information_access_uri=None</em>, <em>cert=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Info" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Tls.Info</span></code> class contains information from a TLS certificate. This
|
||||
class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version (version number) value from the certificate. This attribute
|
||||
was added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>serial_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SerialNumber value from the certificate. This attribute was added
|
||||
in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>signature_algorithm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Signature algorithm name from the certificate. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>issuer_dn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Issuer (issuer distinguished name) value from the certificate. This
|
||||
attribute was added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>valid_from</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – validFrom specify the start date of the certificate. This attribute
|
||||
was added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>valid_to</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – validTo specify the end date of the certificate. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>subject_dn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Subject (subject distinguished name) value from the certificate.
|
||||
This attribute was added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Thumbprint value from the certificate. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>is_ca</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Certificate constraints isCA from the critical BasicConstraints
|
||||
extension, (OID = 2.5.29.19). This attribute was added in vSphere
|
||||
API 6.7.2.</p></li>
|
||||
<li><p><strong>path_length_constraint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Certificate constraints path length from the critical
|
||||
BasicConstraints extension, (OID = 2.5.29.19). This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>key_usage</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>) – Collection of keyusage contained in the certificate. This attribute
|
||||
was added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>extended_key_usage</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>) – Collection of extended keyusage that contains details for which the
|
||||
certificate can be used for. This attribute was added in vSphere
|
||||
API 6.7.2.</p></li>
|
||||
<li><p><strong>subject_alternative_name</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>) – Collection of subject alternative names. This attribute was added
|
||||
in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>authority_information_access_uri</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>) – Collection of authority information access URI. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>cert</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – TLS certificate in PEM format. This attribute was added in vSphere
|
||||
API 6.7.2.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec">
|
||||
<em class="property">class </em><code class="descname">ReplaceSpec</code><span class="sig-paren">(</span><em>key_size=None</em>, <em>common_name=None</em>, <em>organization=None</em>, <em>organization_unit=None</em>, <em>locality=None</em>, <em>state_or_province=None</em>, <em>country=None</em>, <em>email_address=None</em>, <em>subject_alt_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Tls.ReplaceSpec</span></code> class contains information to generate a Private
|
||||
Key , CSR and hence VMCA signed machine SSL. This class was added in
|
||||
vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>key_size</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>) – The size of the key to be used for public and private key
|
||||
generation. This attribute was added in vSphere API 6.7.2.
|
||||
If None the key size will be ‘2048’.</p></li>
|
||||
<li><p><strong>common_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>) – The common name of the host for which certificate is generated.
|
||||
This attribute was added in vSphere API 6.7.2.
|
||||
If None will default to PNID of host.</p></li>
|
||||
<li><p><strong>organization</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization field in certificate subject. This attribute was added
|
||||
in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>organization_unit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization unit field in certificate subject. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>locality</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Locality field in certificate subject. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>state_or_province</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – State field in certificate subject. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>country</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Country field in certificate subject. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>email_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Email field in Certificate extensions. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>subject_alt_name</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SubjectAltName is list of Dns Names and Ip addresses. This
|
||||
attribute was added in vSphere API 6.7.2.
|
||||
If None PNID of host will be used as IPAddress or Hostname for
|
||||
certificate generation .</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec">
|
||||
<em class="property">class </em><code class="descname">Spec</code><span class="sig-paren">(</span><em>cert=None</em>, <em>key=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Tls.Spec</span></code> class contains information for a Certificate and Private
|
||||
Key. This class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cert</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Certificate string in PEM format. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>key</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>) – Private key string in PEM format. This attribute was added in
|
||||
vSphere API 6.7.2.
|
||||
If None the private key from the certificate store will be used. It
|
||||
is required when replacing the certificate with a third party
|
||||
signed certificate.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the rhttpproxy TLS certificate. This method was added in
|
||||
vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Info" title="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tls.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>TLS certificate.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the rhttpproxy certificate is not present in VECS store.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if failed due to generic exception.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.renew">
|
||||
<code class="descname">renew</code><span class="sig-paren">(</span><em>duration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.renew" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Renews the TLS certificate for the given duration period. After this
|
||||
method completes, the services using the certificate must be restarted
|
||||
for the new certificate to take effect. This method was added in
|
||||
vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>duration</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>) – The duration (in days) of the new TLS certificate. The duration
|
||||
should be less than or equal to 730 days.
|
||||
If None, the duration will be 730 days (two years).</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||||
If the TLS certificate is not VMCA generated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
If the duration period specified is invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If the system failed to renew the TLS certificate.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.set">
|
||||
<code class="descname">set</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Replaces the rhttpproxy TLS certificate with the specified certificate.
|
||||
This method can be used in three scenarios :</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p>When the CSR is created and the private key is already stored, this
|
||||
method can replace the certificate. The certificate but not the private
|
||||
key and root certificate must be provided as input.</p></li>
|
||||
<li><p>When the certificate is signed by a third party certificate
|
||||
authority/VMCA and the root certificate of the third party certificate
|
||||
authority/VMCA is already one of the trusted roots in the trust store,
|
||||
this method can replace the certificate and private key. The
|
||||
certificate and the private key but not the root certificate must be
|
||||
provided as input.</p></li>
|
||||
<li><p>When the certificate is signed by a third party certificate
|
||||
authority and the root certificate of the third party certificate
|
||||
authority is not one of the trusted roots in the trust store, this
|
||||
method can replace the certificate, private key and root CA
|
||||
certificate. The certificate, private key and root certificate must be
|
||||
provided as input.</p></li>
|
||||
</ol>
|
||||
<p>After this method completes, the services using the certificate must be
|
||||
restarted for the new certificate to take effect. The above three
|
||||
scenarios are only supported from vsphere 7.0 onwards. This method was
|
||||
added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec" title="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tls.Spec</span></code></a>) – The information needed to replace the TLS certificate.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
If the private key is not present in the VECS store.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||||
If the specified certificate thumbprint is the same as the existing
|
||||
TLS certificate thumbprint.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If the system failed to replace the TLS certificate.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="descname">TlsCsr</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TlsCsr</span></code> interface provides methods to generate certificate signing
|
||||
request. This class was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>csr=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TlsCsr.Info</span></code> class contains information for a Certificate signing
|
||||
request. This class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>csr</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Certificate Signing Request in PEM format. This attribute was added
|
||||
in vSphere API 6.7.2.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec">
|
||||
<em class="property">class </em><code class="descname">Spec</code><span class="sig-paren">(</span><em>key_size=None</em>, <em>common_name=None</em>, <em>organization=None</em>, <em>organization_unit=None</em>, <em>locality=None</em>, <em>state_or_province=None</em>, <em>country=None</em>, <em>email_address=None</em>, <em>subject_alt_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TlsCsr.Spec</span></code> class contains information to generate a Private Key
|
||||
and CSR. This class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>key_size</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>) – This attribute was added in vSphere API 6.7.2.
|
||||
keySize will take 2048 bits if not modified.</p></li>
|
||||
<li><p><strong>common_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>) – This attribute was added in vSphere API 6.7.2.
|
||||
commonName will take PNID if not modified.</p></li>
|
||||
<li><p><strong>organization</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization field in certificate subject. This attribute was added
|
||||
in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>organization_unit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization unit field in certificate subject. This attribute was
|
||||
added in vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>locality</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Locality field in certificate subject. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>state_or_province</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – State field in certificate subject. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>country</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Country field in certificate subject. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>email_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Email field in Certificate extensions. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>subject_alt_name</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 6.7.2.
|
||||
subjectAltName is list of Dns Names and Ip addresses</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generates a CSR with the given Spec. This method was added in vSphere
|
||||
API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec" title="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TlsCsr.Spec</span></code></a>) – The information needed to create a CSR.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info" title="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">TlsCsr.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>A Certificate Signing Request.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If CSR could not be created for given spec for a generic error.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="descname">TrustedRootChains</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TrustedRootChains</span></code> interface provides methods to create, modify,
|
||||
delete and read trusted root certificate chains. This class was added in
|
||||
vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec">
|
||||
<em class="property">class </em><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>cert_chain=None</em>, <em>chain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TrustedRootChains.CreateSpec</span></code> class contains information to create a
|
||||
trusted root certificate chain. This class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cert_chain</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.certificate_management_client.X509CertChain" title="com.vmware.vcenter.certificate_management_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.certificate_management_client.X509CertChain</span></code></a>) – Certificate chain in base64 encoding. This attribute was added in
|
||||
vSphere API 6.7.2.</p></li>
|
||||
<li><p><strong>chain</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>) – Unique identifier for this trusted root. Client can specify at
|
||||
creation as long as it is unique, otherwise one will be generated.
|
||||
An example of a client providing the identifier would be if this
|
||||
trusted root is associated with a VC trust. In this case the
|
||||
identifier would be the domain id. This attribute was added in
|
||||
vSphere API 6.7.2.
|
||||
A unique id will be generated if not given.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>cert_chain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TrustedRootChains.Info</span></code> class contains information for a trusted
|
||||
root certificate chain. This class was added in vSphere API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>cert_chain</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.certificate_management_client.X509CertChain" title="com.vmware.vcenter.certificate_management_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.certificate_management_client.X509CertChain</span></code></a>) – A certificate chain in base64 encoding. This attribute was added in
|
||||
vSphere API 6.7.2.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Summary">
|
||||
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>chain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Summary" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TrustedRootChains.Summary</span></code> class contains a trusted root certificate
|
||||
chain summary suitable for UI presentation. This class was added in vSphere
|
||||
API 6.7.2.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier for chain. This attribute was added in vSphere
|
||||
API 6.7.2.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a new trusted root certificate chain from the CreateSpec. This
|
||||
method was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec" title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustedRootChains.CreateSpec</span></code></a>) – The information needed to create a trusted root certificate chain.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The unique identifier for the new trusted root chain.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if authorization is not given to caller.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||||
if a trusted root certificate chain exists with id in given spec.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>chain</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes trusted root certificate chain for a given identifier. This
|
||||
method was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier for a trusted root cert chain.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if authorization is not given to caller.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if a trusted root certificate chain does not exist for given id.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>chain</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve a trusted root certificate chain for a given identifier. This
|
||||
method was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier for a trusted root cert chain.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info" title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustedRootChains.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>TrustedRootChain.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if authorization is not given to caller.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if a trusted root certificate chain does not exist for given id.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns summary information for each trusted root certificate chain.
|
||||
This method was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.list" title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Summary" title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustedRootChains.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>List of trusted root certificate chains summaries.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if authorization is not given to caller.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="com.vmware.vcenter.compute.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.compute package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.html" class="btn btn-neutral float-left" title="com.vmware.vcenter package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<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>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.compute package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vcenter.compute package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -29,11 +36,7 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vcenter.compute.policies package" href="com.vmware.vcenter.compute.policies.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter package" href="com.vmware.vcenter.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
<link rel="prev" title="com.vmware.vcenter.certificate_management package" href="com.vmware.vcenter.certificate_management.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -180,7 +183,11 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html">com.vmware.vcenter.compute.policies.capabilities package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -213,14 +220,11 @@ retrieving information about a policy (see
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get" title="com.vmware.vcenter.compute_client.Policies.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>). <strong>Warning:</strong> This
|
||||
class is available as technical preview. It may be changed in a future
|
||||
release.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>name=None</em>, <em>description=None</em>, <em>create_spec_type=None</em>, <em>info_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Info" title="Permalink to this definition">¶</a></dt>
|
||||
@ -229,21 +233,19 @@ release.</p>
|
||||
capability. <strong>Warning:</strong> This class is available as technical preview. It
|
||||
may be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>name</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Name of the capability. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</li>
|
||||
<li><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the capability. <strong>Warning:</strong> This attribute is
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Name of the capability. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the capability. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.</li>
|
||||
<li><strong>create_spec_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the class used to create a policy based on this
|
||||
release.</p></li>
|
||||
<li><p><strong>create_spec_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the class used to create a policy based on this
|
||||
capability. See
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create" title="com.vmware.vcenter.compute_client.Policies.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.create()</span></code></a>.
|
||||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||||
@ -252,8 +254,8 @@ When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</li>
|
||||
<li><strong>info_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the class returned when retrieving information about
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p></li>
|
||||
<li><p><strong>info_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the class returned when retrieving information about
|
||||
a policy based on this capability. See
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get" title="com.vmware.vcenter.compute_client.Policies.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>.
|
||||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||||
@ -262,12 +264,10 @@ When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</li>
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
@ -286,16 +286,14 @@ release.</p>
|
||||
a compute policy capability. <strong>Warning:</strong> This class is available as
|
||||
technical preview. It may be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability. <strong>Warning:</strong> This attribute is
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
@ -303,17 +301,15 @@ attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</li>
|
||||
<li><strong>name</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Name of the capability. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</li>
|
||||
<li><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the capability. <strong>Warning:</strong> This attribute is
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Name of the capability. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the capability. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.</li>
|
||||
release.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -322,39 +318,35 @@ release.</li>
|
||||
<dd><p>Returns information about a specific compute policy capability.
|
||||
<strong>Warning:</strong> This method is available as technical preview. It may be
|
||||
changed in a future release.</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"><p class="first"><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability for which information should be
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability for which information should be
|
||||
retrieved.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Info" title="com.vmware.vcenter.compute.policies_client.Capabilities.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Capabilities.Info</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Detailed information about the capability.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Info" title="com.vmware.vcenter.compute.policies_client.Capabilities.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Capabilities.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Detailed information about the capability.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if a capability with this identifier does not exist.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user doesn’t have the required privileges.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="last simple">
|
||||
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</li>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -363,30 +355,26 @@ if you do not have all of the privileges described as follows:</p>
|
||||
<dd><p>Returns information about the compute policy capabilities available in
|
||||
this vCenter server. <strong>Warning:</strong> This method is available as technical
|
||||
preview. It may be changed in a future release.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Capabilities.list" title="com.vmware.vcenter.compute.policies_client.Capabilities.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Summary" title="com.vmware.vcenter.compute.policies_client.Capabilities.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Capabilities.Summary</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The list of compute policy capabilities available on this vCenter
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Capabilities.list" title="com.vmware.vcenter.compute.policies_client.Capabilities.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Summary" title="com.vmware.vcenter.compute.policies_client.Capabilities.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Capabilities.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>The list of compute policy capabilities available on this vCenter
|
||||
server.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user doesn’t have the required privileges.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="last simple">
|
||||
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</li>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -399,25 +387,21 @@ if you do not have all of the privileges described as follows:</p>
|
||||
policy. <strong>Warning:</strong> This class is available as technical preview. It may
|
||||
be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
|
||||
server. <strong>Warning:</strong> This attribute is available as technical
|
||||
preview. It may be changed in a future release.</li>
|
||||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</li>
|
||||
preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -428,20 +412,18 @@ as technical preview. It may be changed in a future release.</li>
|
||||
<strong>Warning:</strong> This class is available as technical preview. It may be
|
||||
changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</li>
|
||||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</li>
|
||||
<li><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
|
||||
This attribute is available as technical preview. It may be changed
|
||||
in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
@ -449,12 +431,10 @@ attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -465,20 +445,17 @@ be an identifier for the resource type:
|
||||
<strong>Warning:</strong> This class is available as technical preview. It may be
|
||||
changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Status.Compliance" title="com.vmware.vcenter.compute.policies_client.Status.Compliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status.Compliance</span></code></a>) – The compliance status of the policy on a specified object.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Status.Compliance" title="com.vmware.vcenter.compute.policies_client.Status.Compliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status.Compliance</span></code></a>) – The compliance status of the policy on a specified object.
|
||||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||||
may be changed in a future release.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
may be changed in a future release.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Status.Compliance">
|
||||
<em class="property">class </em><code class="descname">Compliance</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Status.Compliance" title="Permalink to this definition">¶</a></dt>
|
||||
@ -487,8 +464,8 @@ may be changed in a future release.</td>
|
||||
be in on a particular object. <strong>Warning:</strong> This enumeration is available as
|
||||
technical preview. It may be changed in a future release.</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">This class represents an enumerated type in the interface language
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. 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
|
||||
@ -496,14 +473,11 @@ enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance</span></code> instance.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Status.Compliance.COMPLIANT">
|
||||
<code class="descname">COMPLIANT</code><em class="property"> = Compliance(string='COMPLIANT')</em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Status.Compliance.COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||||
@ -537,14 +511,11 @@ release.</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies_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.vcenter.compute.policies_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -554,14 +525,11 @@ release.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TagUsage</span></code> class provides methods to query which tags are used by
|
||||
policies. <strong>Warning:</strong> This class is available as technical preview. It may
|
||||
be changed in a future release.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec">
|
||||
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>policies=None</em>, <em>tags=None</em>, <em>tag_types=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||||
@ -573,16 +541,14 @@ only the tags used by policies that match an element of each attribute
|
||||
match the filter. <strong>Warning:</strong> This class is available as technical
|
||||
preview. It may be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>policies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – Identifiers that compute policies must have to match the filter.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>policies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – Identifiers that compute policies must have to match the filter.
|
||||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||||
may be changed in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
@ -591,8 +557,8 @@ attribute must contain identifiers for the resource type:
|
||||
of this class as a return value, the attribute will contain
|
||||
identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.
|
||||
If None or empty, then tags used by any policy match this filter.</li>
|
||||
<li><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – Identifiers that tags must have to match the filter. <strong>Warning:</strong>
|
||||
If None or empty, then tags used by any policy match this filter.</p></li>
|
||||
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – Identifiers that tags must have to match the filter. <strong>Warning:</strong>
|
||||
This attribute is available as technical preview. It may be changed
|
||||
in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
@ -601,8 +567,8 @@ attribute must contain identifiers for the resource type:
|
||||
class as a return value, the attribute will contain identifiers for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.
|
||||
If None or empty, then tags with any tag identifier match this
|
||||
filter.</li>
|
||||
<li><strong>tag_types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – Identifiers that tag types must have to match the filter.
|
||||
filter.</p></li>
|
||||
<li><p><strong>tag_types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – Identifiers that tag types must have to match the filter.
|
||||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||||
may be changed in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
@ -610,12 +576,10 @@ attribute must contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will contain identifiers for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>.
|
||||
If None or empty, then tags of any type match this filter.</li>
|
||||
If None or empty, then tags of any type match this filter.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -626,16 +590,14 @@ If None or empty, then tags of any type match this filter.</li>
|
||||
by a policy. <strong>Warning:</strong> This class is available as technical preview. It
|
||||
may be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the policy that uses the tag indicated by
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the policy that uses the tag indicated by
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.tag</span></code>. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.
|
||||
@ -644,8 +606,8 @@ attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>. When methods return a value
|
||||
of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.</li>
|
||||
<li><strong>tag_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the tag type used by the policy indicated by
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.</p></li>
|
||||
<li><p><strong>tag_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the tag type used by the policy indicated by
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.policy</span></code>. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.
|
||||
@ -653,27 +615,25 @@ When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>. When methods return a value of this
|
||||
class as a return value, the attribute will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>.</li>
|
||||
<li><strong>tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the tag used by the policy indicated by
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>.</p></li>
|
||||
<li><p><strong>tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the tag used by the policy indicated by
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.policy</span></code>. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute <code class="docutils literal notranslate"><span class="pre">tagType</span></code> must contain the actual resource type. When
|
||||
methods return a value of this class as a return value, the
|
||||
attribute <code class="docutils literal notranslate"><span class="pre">tagType</span></code> will contain the actual resource type.</li>
|
||||
<li><strong>tag_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the tag used by the policy indicated by
|
||||
attribute <code class="docutils literal notranslate"><span class="pre">tagType</span></code> will contain the actual resource type.</p></li>
|
||||
<li><p><strong>tag_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the tag used by the policy indicated by
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.policy</span></code>. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.</li>
|
||||
<li><strong>category_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the category that has <code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.tag</span></code>.
|
||||
release.</p></li>
|
||||
<li><p><strong>category_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the category that has <code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.tag</span></code>.
|
||||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||||
may be changed in a future release.</li>
|
||||
may be changed in a future release.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -683,36 +643,32 @@ may be changed in a future release.</li>
|
||||
vCenter server matching the <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a>. <strong>Warning:</strong>
|
||||
This method is available as technical preview. It may be changed in a
|
||||
future release.</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"><p class="first"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification for matching tags used by policies.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification for matching tags used by policies.
|
||||
If None, the behavior is equivalent to a
|
||||
<a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a> with all attributes None, which means
|
||||
all tags used by policies match the filter.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.list" title="com.vmware.vcenter.compute.policies_client.TagUsage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.Summary" title="com.vmware.vcenter.compute.policies_client.TagUsage.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.Summary</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The list of tags used by policies available on this vCenter server
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.list" title="com.vmware.vcenter.compute.policies_client.TagUsage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.Summary" title="com.vmware.vcenter.compute.policies_client.TagUsage.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The list of tags used by policies available on this vCenter server
|
||||
matching the <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user doesn’t have the required privileges.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if you do not have all of the privileges described as follows:</p>
|
||||
<ul class="last simple">
|
||||
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</li>
|
||||
<ul class="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -731,7 +687,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
<a href="com.vmware.vcenter.compute.policies.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.compute.policies package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.html" class="btn btn-neutral" title="com.vmware.vcenter package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vcenter.certificate_management.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.certificate_management package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -740,7 +696,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -757,33 +713,16 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.compute.policies.capabilities package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vcenter.compute.policies.capabilities package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vcenter.deployment package" href="com.vmware.vcenter.deployment.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.compute.policies package" href="com.vmware.vcenter.compute.policies.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -178,6 +181,110 @@
|
||||
<span id="com-vmware-vcenter-compute-policies-capabilities-package"></span><h1>com.vmware.vcenter.compute.policies.capabilities package<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client">
|
||||
<span id="com-vmware-vcenter-compute-policies-capabilities-disable-drs-vmotion-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client</span></code>
|
||||
module provides classes for the Disable DRS vMotion capability offered by
|
||||
vCenter.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.CreateSpec">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.</code><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>vm_tag=None</em>, <em>name=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.CreateSpec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">CreateSpec</span></code> class contains information used to create a new
|
||||
DisableDrsVmotion policy, see
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create" title="com.vmware.vcenter.compute_client.Policies.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.create()</span></code></a>. <strong>Warning:</strong>
|
||||
This class is available as technical preview. It may be changed in a future
|
||||
release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
Virtual machines with this tag will not be migrated away from the
|
||||
host on which they are powered on, except when the host is put into
|
||||
maintenance mode or failed over. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
|
||||
a value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
|
||||
server. <strong>Warning:</strong> This attribute is available as technical
|
||||
preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.Info">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.</code><code class="descname">Info</code><span class="sig-paren">(</span><em>vm_tag=None</em>, <em>name=None</em>, <em>description=None</em>, <em>capability=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.Info" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Info</span></code> class contains information about a DisableDrsVmotion policy,
|
||||
see <a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get" title="com.vmware.vcenter.compute_client.Policies.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>. <strong>Warning:</strong>
|
||||
This class is available as technical preview. It may be changed in a future
|
||||
release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
Virtual machines with this tag will not be migrated away from the
|
||||
host on which they are powered on, except when the host is put into
|
||||
maintenance mode or failed over. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
|
||||
a value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
|
||||
This attribute is available as technical preview. It may be changed
|
||||
in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_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.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client">
|
||||
<span id="com-vmware-vcenter-compute-policies-capabilities-vm-host-affinity-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client" title="Permalink to this headline">¶</a></h2>
|
||||
@ -196,16 +303,14 @@ hosts that have the tag indicated by <code class="xref py py-attr docutils liter
|
||||
<strong>Warning:</strong> This class is available as technical preview. It may be
|
||||
changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
Virtual machines with this tag will be affine to the hosts
|
||||
indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.host_tag</span></code>. <strong>Warning:</strong> This
|
||||
attribute is available as technical preview. It may be changed in a
|
||||
@ -215,8 +320,8 @@ attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
|
||||
a value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</li>
|
||||
<li><strong>host_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a host. Virtual
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>host_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a host. Virtual
|
||||
machines indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_tag</span></code> will be affine to
|
||||
hosts with this tag. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.
|
||||
@ -225,17 +330,15 @@ attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:HostSystem</span></code>. When methods return a
|
||||
value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:HostSystem</span></code>.</li>
|
||||
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:HostSystem</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
|
||||
server. <strong>Warning:</strong> This attribute is available as technical
|
||||
preview. It may be changed in a future release.</li>
|
||||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</li>
|
||||
preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -250,16 +353,14 @@ that have the tag indicated by <code class="xref py py-attr docutils literal not
|
||||
class is available as technical preview. It may be changed in a future
|
||||
release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
Virtual machines with this tag will be affine to the hosts
|
||||
indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.host_tag</span></code>. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
@ -269,8 +370,8 @@ attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
|
||||
a value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</li>
|
||||
<li><strong>host_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a host. Virtual
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>host_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a host. Virtual
|
||||
machines indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_tag</span></code> will be affine to hosts
|
||||
with this tag. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.
|
||||
@ -279,12 +380,12 @@ attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:HostSystem</span></code>. When methods return a
|
||||
value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:HostSystem</span></code>.</li>
|
||||
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</li>
|
||||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</li>
|
||||
<li><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:HostSystem</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
|
||||
This attribute is available as technical preview. It may be changed
|
||||
in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
@ -292,12 +393,10 @@ attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -305,14 +404,340 @@ be an identifier for the resource type:
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_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.vcenter.compute.policies.capabilities.vm_host_affinity_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client">
|
||||
<span id="com-vmware-vcenter-compute-policies-capabilities-vm-host-anti-affinity-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client</span></code>
|
||||
module provides classes for the VM Host anti-affinity capability offered by
|
||||
vCenter.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.CreateSpec">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.</code><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>vm_tag=None</em>, <em>host_tag=None</em>, <em>name=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.CreateSpec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">CreateSpec</span></code> class contains information used to create a new virtual
|
||||
machine to host anti-affinity policy, see
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create" title="com.vmware.vcenter.compute_client.Policies.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.create()</span></code></a>. Virtual machines
|
||||
that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_tag</span></code> will be
|
||||
anti-affine to hosts that have the tag indicated by
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.host_tag</span></code>. <strong>Warning:</strong> This class is available as
|
||||
technical preview. It may be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
Virtual machines with this tag will be anti-affine to the hosts
|
||||
indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.host_tag</span></code>. <strong>Warning:</strong> This
|
||||
attribute is available as technical preview. It may be changed in a
|
||||
future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
|
||||
a value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>host_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a host. Virtual
|
||||
machines indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_tag</span></code> will be anti-affine
|
||||
to hosts with this tag. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:HostSystem</span></code>. When methods return a
|
||||
value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:HostSystem</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
|
||||
server. <strong>Warning:</strong> This attribute is available as technical
|
||||
preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.Info">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.</code><code class="descname">Info</code><span class="sig-paren">(</span><em>vm_tag=None</em>, <em>host_tag=None</em>, <em>name=None</em>, <em>description=None</em>, <em>capability=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.Info" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Info</span></code> class contains information about a virtual machine to host
|
||||
anti-affinity policy, see
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get" title="com.vmware.vcenter.compute_client.Policies.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>. Virtual machines
|
||||
that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_tag</span></code> will be anti-affine to
|
||||
hosts that have the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.host_tag</span></code>. <strong>Warning:</strong>
|
||||
This class is available as technical preview. It may be changed in a future
|
||||
release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
Virtual machines with this tag will be anti-affine to the hosts
|
||||
indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.host_tag</span></code>. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
|
||||
a value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>host_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a host. Virtual
|
||||
machines indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_tag</span></code> will be anti-affine to
|
||||
hosts with this tag. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:HostSystem</span></code>. When methods return a
|
||||
value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:HostSystem</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
|
||||
This attribute is available as technical preview. It may be changed
|
||||
in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_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.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client">
|
||||
<span id="com-vmware-vcenter-compute-policies-capabilities-vm-vm-affinity-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client</span></code>
|
||||
module provides classes for the VM-VM affinity capability offered by vCenter.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.CreateSpec">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.</code><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>vm_tag=None</em>, <em>name=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.CreateSpec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">CreateSpec</span></code> class contains information used to create a new VM-VM
|
||||
affinity policy, see
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create" title="com.vmware.vcenter.compute_client.Policies.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.create()</span></code></a>. All virtual
|
||||
machines that share the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_tag</span></code> will be
|
||||
affined to each other. <strong>Warning:</strong> This class is available as technical
|
||||
preview. It may be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
Virtual machines with this tag will be affined to each other.
|
||||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||||
may be changed in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
|
||||
a value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
|
||||
server. <strong>Warning:</strong> This attribute is available as technical
|
||||
preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.Info">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.</code><code class="descname">Info</code><span class="sig-paren">(</span><em>vm_tag=None</em>, <em>name=None</em>, <em>description=None</em>, <em>capability=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.Info" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Info</span></code> class contains information about a VM-VM affinity policy, see
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get" title="com.vmware.vcenter.compute_client.Policies.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>. All virtual
|
||||
machines that share the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_tag</span></code> are affined to
|
||||
each other. <strong>Warning:</strong> This class is available as technical preview. It
|
||||
may be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
Virtual machines with this tag will be affined to each other.
|
||||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||||
may be changed in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
|
||||
a value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
|
||||
This attribute is available as technical preview. It may be changed
|
||||
in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_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.vcenter.compute.policies.capabilities.vm_vm_affinity_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client">
|
||||
<span id="com-vmware-vcenter-compute-policies-capabilities-vm-vm-anti-affinity-client-module"></span><h2>com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client</span></code>
|
||||
module provides classes for the VM VM anti-affinity capability offered by
|
||||
vCenter.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.CreateSpec">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.</code><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>vm_tag=None</em>, <em>name=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.CreateSpec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">CreateSpec</span></code> class contains information used to create a new VM-VM
|
||||
anti-affinity policy, see
|
||||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create" title="com.vmware.vcenter.compute_client.Policies.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.create()</span></code></a>. All virtual
|
||||
machines that share the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">CreateSpec.vm_tag</span></code> will be
|
||||
anti-affine to each other. <strong>Warning:</strong> This class is available as
|
||||
technical preview. It may be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
Virtual machines with this tag will be anti-affine to each other.
|
||||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||||
may be changed in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
|
||||
a value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
|
||||
server. <strong>Warning:</strong> This attribute is available as technical
|
||||
preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.Info">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.</code><code class="descname">Info</code><span class="sig-paren">(</span><em>vm_tag=None</em>, <em>name=None</em>, <em>description=None</em>, <em>capability=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.Info" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Info</span></code> class contains information about a VM-VM anti-affinity policy,
|
||||
see <a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get" title="com.vmware.vcenter.compute_client.Policies.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>. All virtual
|
||||
machines that share the tag indicated by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.vm_tag</span></code> are
|
||||
anti-affine to each other. <strong>Warning:</strong> This class is available as
|
||||
technical preview. It may be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of a tag that can be associated with a virtual machine.
|
||||
Virtual machines with this tag are anti-affine to each other.
|
||||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||||
may be changed in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>. When methods return
|
||||
a value of this class as a return value, the attribute will be an
|
||||
identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag:VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
|
||||
as technical preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
|
||||
This attribute is available as technical preview. It may be changed
|
||||
in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_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.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -329,7 +754,7 @@ be an identifier for the resource type:
|
||||
<a href="com.vmware.vcenter.deployment.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.deployment package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.compute.policies.html" class="btn btn-neutral" title="com.vmware.vcenter.compute.policies package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vcenter.compute.policies.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.compute.policies package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -338,7 +763,7 @@ be an identifier for the resource type:
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -355,33 +780,16 @@ be an identifier for the resource type:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.compute.policies package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vcenter.compute.policies package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vcenter.compute.policies.capabilities package" href="com.vmware.vcenter.compute.policies.capabilities.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.compute package" href="com.vmware.vcenter.compute.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -180,7 +183,11 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html">com.vmware.vcenter.compute.policies.capabilities package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -198,14 +205,11 @@ classes for compute policy capabilities offered by vCenter.</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities_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.vcenter.compute.policies.capabilities_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -222,7 +226,7 @@ classes for compute policy capabilities offered by vCenter.</p>
|
||||
<a href="com.vmware.vcenter.compute.policies.capabilities.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.compute.policies.capabilities package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.compute.html" class="btn btn-neutral" title="com.vmware.vcenter.compute package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vcenter.compute.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.compute package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -231,7 +235,7 @@ classes for compute policy capabilities offered by vCenter.</p>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -248,33 +252,16 @@ classes for compute policy capabilities offered by vCenter.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.deployment package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vcenter.deployment package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vcenter.deployment.install package" href="com.vmware.vcenter.deployment.install.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.compute.policies.capabilities package" href="com.vmware.vcenter.compute.policies.capabilities.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -203,47 +206,47 @@
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">RemotePsc</span></code> class provides methods to check if the deployed vCenter
|
||||
Server can register with the remote PSC. This class was added in vSphere
|
||||
API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.deployment.install_client.RemotePsc.check">
|
||||
<code class="descname">check</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install_client.RemotePsc.check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checks whether the remote PSC is reachable and the deployed vCenter
|
||||
Server can be registered with the remote PSC. This method was added in
|
||||
vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.RemotePscSpec" title="com.vmware.vcenter.deployment_client.RemotePscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.RemotePscSpec</span></code></a>) – Information to connect to the remote PSC.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.CheckInfo</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Information about the success or failure of the checks that were
|
||||
performed.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
if the caller is not authenticated.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.RemotePscSpec" title="com.vmware.vcenter.deployment_client.RemotePscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.RemotePscSpec</span></code></a>) – Information to connect to the remote PSC.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.CheckInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about the success or failure of the checks that were
|
||||
performed.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if external PSC credentials are not valid when configuring a
|
||||
VCSA_EXTERNAL appliance.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
||||
if passed arguments are invalid.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
||||
if the appliance is not in INITIALIZED state.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
VCSA_EXTERNAL appliance.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if passed arguments are invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if the appliance is not in INITIALIZED state.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -253,14 +256,11 @@ if the appliance is not in INITIALIZED state.</td>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.deployment.install_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.vcenter.deployment.install_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -277,7 +277,7 @@ if the appliance is not in INITIALIZED state.</td>
|
||||
<a href="com.vmware.vcenter.deployment.install.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.deployment.install package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.compute.policies.capabilities.html" class="btn btn-neutral" title="com.vmware.vcenter.compute.policies.capabilities package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vcenter.compute.policies.capabilities.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.compute.policies.capabilities package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -286,7 +286,7 @@ if the appliance is not in INITIALIZED state.</td>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -303,33 +303,16 @@ if the appliance is not in INITIALIZED state.</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.deployment.install package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vcenter.deployment.install package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vcenter.deployment.install.initial_config package" href="com.vmware.vcenter.deployment.install.initial_config.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.deployment package" href="com.vmware.vcenter.deployment.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -197,46 +200,46 @@
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Replicated</span></code> class provides methods to check if the configuring
|
||||
vCenter Server can be replicated to the remote PSC. This class was added in
|
||||
vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.deployment.install.psc_client.Replicated.check">
|
||||
<code class="descname">check</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install.psc_client.Replicated.check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checks whether the provided remote PSC is reachable and can be
|
||||
replicated. This method was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.ReplicatedPscSpec" title="com.vmware.vcenter.deployment_client.ReplicatedPscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.ReplicatedPscSpec</span></code></a>) – Information to configure a replicated PSC.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.CheckInfo</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Information about the success or failure of the checks that were
|
||||
performed.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
if the caller is not authenticated.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
replicated. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.ReplicatedPscSpec" title="com.vmware.vcenter.deployment_client.ReplicatedPscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.ReplicatedPscSpec</span></code></a>) – Information to configure a replicated PSC.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.CheckInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about the success or failure of the checks that were
|
||||
performed.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if external PSC credentials are not valid when configuring PSC to
|
||||
replicate with an external existing PSC.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
||||
if passed arguments are invalid.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
||||
if the appliance is not in INITIALIZED state.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
replicate with an external existing PSC.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if passed arguments are invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if the appliance is not in INITIALIZED state.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -247,42 +250,41 @@ if the appliance is not in INITIALIZED state.</td>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Standalone</span></code> class provides methods to check if the values provided
|
||||
for the standalone PSC satisfies the requirements. This class was added in
|
||||
vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.deployment.install.psc_client.Standalone.check">
|
||||
<code class="descname">check</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install.psc_client.Standalone.check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checks that the information to configure a non-replicated PSC satisfies
|
||||
the requirements. This method was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.StandalonePscSpec" title="com.vmware.vcenter.deployment_client.StandalonePscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.StandalonePscSpec</span></code></a>) – Information to configure a non-replicated PSC.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.CheckInfo</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Information about the success or failure of the checks that were
|
||||
performed.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
if the caller is not authenticated.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
||||
if passed arguments are invalid.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
||||
if the appliance is not in INITIALIZED state.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
the requirements. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.StandalonePscSpec" title="com.vmware.vcenter.deployment_client.StandalonePscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.StandalonePscSpec</span></code></a>) – Information to configure a non-replicated PSC.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.CheckInfo</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about the success or failure of the checks that were
|
||||
performed.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if passed arguments are invalid.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||||
if the appliance is not in INITIALIZED state.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -292,14 +294,11 @@ if the appliance is not in INITIALIZED state.</td>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.deployment.install.psc_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.vcenter.deployment.install.psc_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -316,7 +315,7 @@ if the appliance is not in INITIALIZED state.</td>
|
||||
<a href="com.vmware.vcenter.deployment.install.initial_config.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.deployment.install.initial_config package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.deployment.html" class="btn btn-neutral" title="com.vmware.vcenter.deployment package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vcenter.deployment.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.deployment package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -325,7 +324,7 @@ if the appliance is not in INITIALIZED state.</td>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -342,33 +341,16 @@ if the appliance is not in INITIALIZED state.</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.deployment.install.initial_config package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vcenter.deployment.install.initial_config package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vcenter.hvc package" href="com.vmware.vcenter.hvc.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.deployment.install package" href="com.vmware.vcenter.deployment.install.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -186,14 +189,11 @@
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.deployment.install.initial_config.remote_psc_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.vcenter.deployment.install.initial_config.remote_psc_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -201,66 +201,60 @@
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.</code><code class="descname">Thumbprint</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.Thumbprint" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Thumbprint</span></code> class provides methods to get the thumbprint of the
|
||||
remote PSC. This class was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
remote PSC. This class was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.Thumbprint.RemoteSpec">
|
||||
<em class="property">class </em><code class="descname">RemoteSpec</code><span class="sig-paren">(</span><em>address=None</em>, <em>https_port=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.Thumbprint.RemoteSpec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Thumbprint.RemoteSpec</span></code> class contains the information used to
|
||||
connect to the remote PSC. This class was added in vSphere API 6.7</p>
|
||||
connect to the remote PSC. This class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IP address or DNS resolvable name of the remote PSC. This
|
||||
attribute was added in vSphere API 6.7</li>
|
||||
<li><strong>https_port</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>) – The HTTPS port of the remote PSC. This attribute was added in
|
||||
vSphere API 6.7
|
||||
If None, port 443 will be used.</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IP address or DNS resolvable name of the remote PSC. This
|
||||
attribute was added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>https_port</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>) – The HTTPS port of the remote PSC. This attribute was added in
|
||||
vSphere API 6.7.
|
||||
If None, port 443 will be used.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.Thumbprint.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.Thumbprint.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets the SHA1 thumbprint of the remote PSC. This method was added in
|
||||
vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.Thumbprint.RemoteSpec" title="com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.Thumbprint.RemoteSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Thumbprint.RemoteSpec</span></code></a>) – Information used to connect to the remote PSC.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The thumbprint of the specified remote PSC</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
if the caller is not authenticated.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
on exception.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.Thumbprint.RemoteSpec" title="com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.Thumbprint.RemoteSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Thumbprint.RemoteSpec</span></code></a>) – Information used to connect to the remote PSC.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The thumbprint of the specified remote PSC</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the caller is not authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
on exception.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -279,7 +273,7 @@ on exception.</td>
|
||||
<a href="com.vmware.vcenter.hvc.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.hvc package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.deployment.install.html" class="btn btn-neutral" title="com.vmware.vcenter.deployment.install package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vcenter.deployment.install.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.deployment.install package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -288,7 +282,7 @@ on exception.</td>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -305,33 +299,16 @@ on exception.</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.hvc package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vcenter.hvc package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vcenter.hvc.links package" href="com.vmware.vcenter.hvc.links.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.deployment.install.initial_config package" href="com.vmware.vcenter.deployment.install.initial_config.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -194,14 +197,11 @@
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.hvc.links_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.vcenter.hvc.links_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -211,14 +211,36 @@
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Sync</span></code> class provides methods to create a sync session, get
|
||||
information on Sync. <strong>Warning:</strong> This class is available as technical
|
||||
preview. It may be changed in a future release.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.links_client.Sync.Credentials">
|
||||
<em class="property">class </em><code class="descname">Credentials</code><span class="sig-paren">(</span><em>user_name=None</em>, <em>password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links_client.Sync.Credentials" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Sync.Credentials</span></code> class specifies user credentials to make a
|
||||
successful connection to remote endpoint. <strong>Warning:</strong> This class is
|
||||
available as technical preview. It may be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the user to authenticate. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.</p></li>
|
||||
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Password for the user. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.hvc.links_client.Sync.reset">
|
||||
<code class="descname">reset</code><span class="sig-paren">(</span><em>link</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links_client.Sync.reset" title="Permalink to this definition">¶</a></dt>
|
||||
@ -226,25 +248,25 @@ preview. It may be changed in a future release.</p>
|
||||
sync for all providers. If an existing sync is in progress this cancels
|
||||
the sync. <strong>Warning:</strong> This method is available as technical preview.
|
||||
It may be changed in a future release.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier of the link.
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier of the link.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
if the system reports an error while responding to the request.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
if the link Identifier associated with <code class="docutils literal notranslate"><span class="pre">link</span></code> does not exist.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
if the user is not authorized to perform this operation.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the link Identifier associated with <code class="docutils literal notranslate"><span class="pre">link</span></code> does not exist.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user is not authorized to perform this operation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -260,34 +282,30 @@ if the user is not authorized to perform this operation.</td>
|
||||
in the local sso group. This is limited to the Hybrid Linked Mode service.
|
||||
<strong>Warning:</strong> This class is available as technical preview. It may be
|
||||
changed in a future release.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.hvc.management_client.Administrators.add">
|
||||
<code class="descname">add</code><span class="sig-paren">(</span><em>group_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add the local sso group with the new group. <strong>Warning:</strong> This method is
|
||||
available as technical preview. It may be changed in a future release.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>group_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the new group to be added. Ex - xyz\@abc.com where xyz
|
||||
is the group name and abc.com is the domain name</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
If the user is not authorized.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
if the system reports an error while responding to the request.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>group_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the new group to be added. Ex - xyz\@abc.com where xyz
|
||||
is the group name and abc.com is the domain name</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
If the user is not authorized.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -296,19 +314,18 @@ if the system reports an error while responding to the request.</td>
|
||||
<dd><p>Enumerates the set of all the groups in the local sso group.
|
||||
<strong>Warning:</strong> This method is available as technical preview. It may be
|
||||
changed in a future release.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="com.vmware.vcenter.hvc.management_client.Administrators.set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="com.vmware.vcenter.hvc.management_client.Administrators.set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of all the groups.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
if the system reports an error while responding to the request.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="com.vmware.vcenter.hvc.management_client.Administrators.set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>The <a class="reference internal" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="com.vmware.vcenter.hvc.management_client.Administrators.set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of all the groups.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -316,21 +333,20 @@ if the system reports an error while responding to the request.</td>
|
||||
<code class="descname">remove</code><span class="sig-paren">(</span><em>group_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove the group from the local sso group. <strong>Warning:</strong> This method is
|
||||
available as technical preview. It may be changed in a future release.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>group_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the group to be removed. Ex - xyz\@abc.com where xyz is
|
||||
the group name and abc.com is the domain name</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
If the user is not authorized.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
if the system reports an error while responding to the request.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>group_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the group to be removed. Ex - xyz\@abc.com where xyz is
|
||||
the group name and abc.com is the domain name</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
If the user is not authorized.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -338,21 +354,20 @@ if the system reports an error while responding to the request.</td>
|
||||
<code class="descname">set</code><span class="sig-paren">(</span><em>group_names</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the groups in the local sso group. <strong>Warning:</strong> This method is
|
||||
available as technical preview. It may be changed in a future release.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>group_names</strong> (<a class="reference internal" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="com.vmware.vcenter.hvc.management_client.Administrators.set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Names the groups to be in the CloudAdminGroup Ex - xyz\@abc.com
|
||||
where xyz is the group name and abc.com is the domain name</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
If the user is not authorized.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
if the system reports an error while responding to the request.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>group_names</strong> (<a class="reference internal" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="com.vmware.vcenter.hvc.management_client.Administrators.set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Names the groups to be in the CloudAdminGroup Ex - xyz\@abc.com
|
||||
where xyz is the group name and abc.com is the domain name</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
If the user is not authorized.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -362,14 +377,11 @@ if the system reports an error while responding to the request.</td>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.hvc.management_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.vcenter.hvc.management_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -386,7 +398,7 @@ if the system reports an error while responding to the request.</td>
|
||||
<a href="com.vmware.vcenter.hvc.links.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.hvc.links package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.deployment.install.initial_config.html" class="btn btn-neutral" title="com.vmware.vcenter.deployment.install.initial_config package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vcenter.deployment.install.initial_config.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.deployment.install.initial_config package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -395,7 +407,7 @@ if the system reports an error while responding to the request.</td>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -412,33 +424,16 @@ if the system reports an error while responding to the request.</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.hvc.links package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vcenter.hvc.links package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vcenter.storage package" href="com.vmware.vcenter.storage.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.hvc package" href="com.vmware.vcenter.hvc.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -186,14 +189,36 @@
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers</span></code> class provides methods to create a sync session, get
|
||||
information on Sync. <strong>Warning:</strong> This class is available as technical
|
||||
preview. It may be changed in a future release.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.Credentials">
|
||||
<em class="property">class </em><code class="descname">Credentials</code><span class="sig-paren">(</span><em>user_name=None</em>, <em>password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Credentials" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Credentials</span></code> class specifies user credentials to make a
|
||||
successful connection to remote endpoint. <strong>Warning:</strong> This class is
|
||||
available as technical preview. It may be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the user to authenticate. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.</p></li>
|
||||
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Password for the user. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>last_sync_time=None</em>, <em>status=None</em>, <em>polling_interval_in_seconds=None</em>, <em>current_session_info=None</em>, <em>status_message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Info" title="Permalink to this definition">¶</a></dt>
|
||||
@ -202,41 +227,37 @@ preview. It may be changed in a future release.</p>
|
||||
provider. <strong>Warning:</strong> This class is available as technical preview. It may
|
||||
be changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>last_sync_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>) – Last sync time for the provider. This indicates the last time that
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>last_sync_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>) – Last sync time for the provider. This indicates the last time that
|
||||
either a background sync or a force sync was started for the
|
||||
provider. <strong>Warning:</strong> This attribute is available as technical
|
||||
preview. It may be changed in a future release.
|
||||
If None no sync was found for the provider.</li>
|
||||
<li><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status" title="com.vmware.vcenter.hvc.links.sync_client.Providers.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Status</span></code></a>) – Last Sync status for the provider. <strong>Warning:</strong> This attribute is
|
||||
If None no sync was found for the provider.</p></li>
|
||||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status" title="com.vmware.vcenter.hvc.links.sync_client.Providers.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Status</span></code></a>) – Last Sync status for the provider. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.</li>
|
||||
<li><strong>polling_interval_in_seconds</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Sync Polling interval between local and remote replicas for the
|
||||
release.</p></li>
|
||||
<li><p><strong>polling_interval_in_seconds</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Sync Polling interval between local and remote replicas for the
|
||||
provider. <strong>Warning:</strong> This attribute is available as technical
|
||||
preview. It may be changed in a future release.</li>
|
||||
<li><strong>current_session_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo" title="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.SessionInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Returns information on the forced sync for the provider.
|
||||
preview. It may be changed in a future release.</p></li>
|
||||
<li><p><strong>current_session_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo" title="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.SessionInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Returns information on the forced sync for the provider.
|
||||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||||
may be changed in a future release.
|
||||
If None there is no outstanding sync session created for this
|
||||
provider</li>
|
||||
<li><strong>status_message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localizable messages associated with sync status. <strong>Warning:</strong> This
|
||||
provider</p></li>
|
||||
<li><p><strong>status_message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localizable messages associated with sync status. <strong>Warning:</strong> This
|
||||
attribute is available as technical preview. It may be changed in a
|
||||
future release.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is <a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED" title="com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Status.FAILED</span></code></a>.</li>
|
||||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is <a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED" title="com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Status.FAILED</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
@ -254,41 +275,37 @@ available as technical preview. It may be changed in a future release.</p>
|
||||
<strong>Warning:</strong> This class is available as technical preview. It may be
|
||||
changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>stage</strong> (<a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage" title="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.SessionInfo.Stage</span></code></a>) – Sync stage for the session. <strong>Warning:</strong> This attribute is
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>stage</strong> (<a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage" title="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.SessionInfo.Stage</span></code></a>) – Sync stage for the session. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.</li>
|
||||
<li><strong>completed_work</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Completed work for the session. <strong>Warning:</strong> This attribute is
|
||||
release.</p></li>
|
||||
<li><p><strong>completed_work</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Completed work for the session. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.</li>
|
||||
<li><strong>total_work</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Total work for the session. <strong>Warning:</strong> This attribute is
|
||||
release.</p></li>
|
||||
<li><p><strong>total_work</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Total work for the session. <strong>Warning:</strong> This attribute is
|
||||
available as technical preview. It may be changed in a future
|
||||
release.</li>
|
||||
<li><strong>completion_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time at which forced sync session was completed. <strong>Warning:</strong> This
|
||||
release.</p></li>
|
||||
<li><p><strong>completion_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time at which forced sync session was completed. <strong>Warning:</strong> This
|
||||
attribute is available as technical preview. It may be changed in a
|
||||
future release.
|
||||
If None there is an ongoing sync that has not completed</li>
|
||||
<li><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time at which force sync was initiated. <strong>Warning:</strong> This attribute
|
||||
If None there is an ongoing sync that has not completed</p></li>
|
||||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time at which force sync was initiated. <strong>Warning:</strong> This attribute
|
||||
is available as technical preview. It may be changed in a future
|
||||
release.</li>
|
||||
<li><strong>exception</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Exception message if there is a sync failure on forced sync.
|
||||
release.</p></li>
|
||||
<li><p><strong>exception</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Exception message if there is a sync failure on forced sync.
|
||||
<strong>Warning:</strong> This attribute is available as technical preview. It
|
||||
may be changed in a future release.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">stage</span></code> is <a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED" title="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.SessionInfo.Stage.FAILED</span></code></a>.</li>
|
||||
of <code class="docutils literal notranslate"><span class="pre">stage</span></code> is <a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED" title="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.SessionInfo.Stage.FAILED</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage">
|
||||
<em class="property">class </em><code class="descname">Stage</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage" title="Permalink to this definition">¶</a></dt>
|
||||
@ -297,8 +314,8 @@ of <code class="docutils literal notranslate"><span class="pre">stage</span></co
|
||||
Sync. <strong>Warning:</strong> This enumeration is available as technical preview. It
|
||||
may be changed in a future release.</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">This class represents an enumerated type in the interface language
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. 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
|
||||
@ -306,14 +323,11 @@ enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Stage</span></code> instance.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Stage</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_APPLICATION">
|
||||
<code class="descname">CHANGE_APPLICATION</code><em class="property"> = Stage(string='CHANGE_APPLICATION')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_APPLICATION" title="Permalink to this definition">¶</a></dt>
|
||||
@ -372,8 +386,8 @@ release.</p>
|
||||
enumeration is available as technical preview. It may be changed in a
|
||||
future release.</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">This class represents an enumerated type in the interface language
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. 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
|
||||
@ -381,14 +395,11 @@ enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED">
|
||||
<code class="descname">FAILED</code><em class="property"> = Status(string='FAILED')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED" title="Permalink to this definition">¶</a></dt>
|
||||
@ -420,25 +431,22 @@ technical preview. It may be changed in a future release.</p>
|
||||
<strong>Warning:</strong> This class is available as technical preview. It may be
|
||||
changed in a future release.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sync provider id. <strong>Warning:</strong> This attribute is available as
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sync provider id. <strong>Warning:</strong> This attribute is available as
|
||||
technical preview. It may be changed in a future release.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.links.sync.Providers</span></code>. When methods
|
||||
return a value of this class as a return value, the attribute will
|
||||
be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.links.sync.Providers</span></code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.links.sync.Providers</span></code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -446,40 +454,36 @@ be an identifier for the resource type:
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>link</em>, <em>provider</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets Sync information for a sync provider. <strong>Warning:</strong> This method is
|
||||
available as technical preview. It may be changed in a future release.</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>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier of the link
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier of the link
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</li>
|
||||
<li><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier of the sync provider.
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</p></li>
|
||||
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier of the sync provider.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.sync.Providers</span></code>.</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.sync.Providers</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Info" title="com.vmware.vcenter.hvc.links.sync_client.Providers.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Info</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The Info of sync information for the provider.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Info" title="com.vmware.vcenter.hvc.links.sync_client.Providers.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The Info of sync information for the provider.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the sync provider associated with <code class="docutils literal notranslate"><span class="pre">provider</span></code> does not exist.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user is not authorized to perform this operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -487,26 +491,27 @@ if the user is not authorized to perform this operation.</p>
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>link</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enumerates the sync providers. <strong>Warning:</strong> This method is available as
|
||||
technical preview. It may be changed in a future release.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier of the link
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier of the link
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.list" title="com.vmware.vcenter.hvc.links.sync_client.Providers.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Summary" title="com.vmware.vcenter.hvc.links.sync_client.Providers.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Summary</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.list" title="com.vmware.vcenter.hvc.links.sync_client.Providers.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of sync provider information.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
If list fails.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
If the user is not authorized to perform this operation.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.list" title="com.vmware.vcenter.hvc.links.sync_client.Providers.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Summary" title="com.vmware.vcenter.hvc.links.sync_client.Providers.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.list" title="com.vmware.vcenter.hvc.links.sync_client.Providers.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of sync provider information.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
If list fails.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
If the user is not authorized to perform this operation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -515,39 +520,35 @@ If the user is not authorized to perform this operation.</td>
|
||||
<dd><p>Initiates synchronization between the local and remote replicas for the
|
||||
sync provider. <strong>Warning:</strong> This method is available as technical
|
||||
preview. It may be changed in a future release.</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>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier of the link
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier of the link
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</li>
|
||||
<li><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier representing the sync provider
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</p></li>
|
||||
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier representing the sync provider
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.sync.Providers</span></code>.</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.sync.Providers</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if the link associated with <code class="docutils literal notranslate"><span class="pre">link</span></code> does not exist if the provider
|
||||
associated with <code class="docutils literal notranslate"><span class="pre">provider</span></code> is not registered for sync</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user is not authorized to perform this operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.ResourceBusy</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
||||
if a sync is already running.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -557,14 +558,11 @@ if a sync is already running.</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.hvc.links.sync_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.vcenter.hvc.links.sync_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -581,7 +579,7 @@ if a sync is already running.</p>
|
||||
<a href="com.vmware.vcenter.storage.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.storage package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.hvc.html" class="btn btn-neutral" title="com.vmware.vcenter.hvc package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vcenter.hvc.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.hvc package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -590,7 +588,7 @@ if a sync is already running.</p>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -607,33 +605,16 @@ if a sync is already running.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.storage package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vcenter.storage package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vcenter.storage.policies package" href="com.vmware.vcenter.storage.policies.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.hvc.links package" href="com.vmware.vcenter.hvc.links.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -195,36 +198,30 @@
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The Compliance class provides methods related to all the associated
|
||||
entities of given compliance statuses. This class was added in vSphere API
|
||||
6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec">
|
||||
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>status=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Compliance.FilterSpec</span></code> class contains complianceStatus used to
|
||||
filter the results when listing entities (see <a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.list" title="com.vmware.vcenter.storage.policies_client.Compliance.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Compliance.list()</span></code></a>).
|
||||
This class was added in vSphere API 6.7</p>
|
||||
This class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status" title="com.vmware.vcenter.storage.policies_client.Compliance.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Status</span></code></a>) – Compliance Status that a virtual machine must have to match the
|
||||
filter. This attribute was added in vSphere API 6.7</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status" title="com.vmware.vcenter.storage.policies_client.Compliance.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Status</span></code></a>) – Compliance Status that a virtual machine must have to match the
|
||||
filter. This attribute was added in vSphere API 6.7.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -232,10 +229,10 @@ filter. This attribute was added in vSphere API 6.7</td>
|
||||
<em class="property">class </em><code class="descname">Status</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>This enumeration defines the set of status values for a compliance
|
||||
operation. This enumeration was added in vSphere API 6.7</p>
|
||||
operation. This enumeration was added in vSphere API 6.7.</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">This class represents an enumerated type in the interface language
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. 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
|
||||
@ -243,25 +240,22 @@ enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.Compliance.Status.COMPLIANT">
|
||||
<code class="descname">COMPLIANT</code><em class="property"> = Status(string='COMPLIANT')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status.COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entity is in compliance. This class attribute was added in vSphere API 6.7</p>
|
||||
<dd><p>Entity is in compliance. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.Compliance.Status.NON_COMPLIANT">
|
||||
<code class="descname">NON_COMPLIANT</code><em class="property"> = Status(string='NON_COMPLIANT')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status.NON_COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entity is out of compliance. This class attribute was added in vSphere API
|
||||
6.7</p>
|
||||
6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
@ -270,7 +264,7 @@ type description page</span></a>.</p>
|
||||
<dd><p>Compliance computation is not applicable for this entity because it does
|
||||
not have any storage requirement that apply to the object-based datastore
|
||||
on which the entity is placed. This class attribute was added in vSphere
|
||||
API 6.7</p>
|
||||
API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
@ -279,14 +273,14 @@ API 6.7</p>
|
||||
<dd><p>Compliance status becomes out of date when the profile associated with the
|
||||
entity is edited and not applied. The compliance status will remain out of
|
||||
date until the latest policy is applied to the entity. This class attribute
|
||||
was added in vSphere API 6.7</p>
|
||||
was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.Compliance.Status.UNKNOWN">
|
||||
<code class="descname">UNKNOWN</code><em class="property"> = Status(string='UNKNOWN')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status.UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Compliance status of the entity is not known. This class attribute was
|
||||
added in vSphere API 6.7</p>
|
||||
added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -297,29 +291,27 @@ added in vSphere API 6.7</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>Provides the details of a virtual machine and its associated entities which
|
||||
match the given compliance statuses. This class was added in vSphere API
|
||||
6.7</p>
|
||||
6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of virtual machine. This attribute was added in vSphere
|
||||
API 6.7
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of virtual machine. This attribute was added in vSphere
|
||||
API 6.7.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>. When methods return a value of this class as a
|
||||
return value, the attribute will be an identifier for the resource
|
||||
type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
||||
<li><strong>vm_home</strong> (<a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status" title="com.vmware.vcenter.storage.policies_client.Compliance.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Status</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Compliance status of the virtual machine home. This attribute was
|
||||
added in vSphere API 6.7
|
||||
If None or empty, vmHome is not associated with a storage policy.</li>
|
||||
<li><strong>disks</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status" title="com.vmware.vcenter.storage.policies_client.Compliance.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Status</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of the virtual hard disk. This attribute was added in vSphere
|
||||
API 6.7
|
||||
type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>vm_home</strong> (<a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status" title="com.vmware.vcenter.storage.policies_client.Compliance.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Status</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Compliance status of the virtual machine home. This attribute was
|
||||
added in vSphere API 6.7.
|
||||
If None or empty, vmHome is not associated with a storage policy.</p></li>
|
||||
<li><p><strong>disks</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status" title="com.vmware.vcenter.storage.policies_client.Compliance.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Status</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of the virtual hard disk. This attribute was added in vSphere
|
||||
API 6.7.
|
||||
When clients pass a value of this class as a parameter, the key in
|
||||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
|
||||
@ -327,12 +319,10 @@ a value of this class as a return value, the key in the attribute
|
||||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.
|
||||
If None or empty, virtual machine entity does not have any disks or
|
||||
its disks are not associated with a storage policy.</li>
|
||||
its disks are not associated with a storage policy.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -340,38 +330,42 @@ its disks are not associated with a storage policy.</li>
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>filter</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns compliance information about entities matching the filter
|
||||
<a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec" title="com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.FilterSpec</span></code></a>. Entities without storage policy
|
||||
association are not returned. This method was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec" title="com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.FilterSpec</span></code></a>) – compliance status of matching entities for which information should
|
||||
be returned.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.list" title="com.vmware.vcenter.storage.policies_client.Compliance.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.Summary" title="com.vmware.vcenter.storage.policies_client.Compliance.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Summary</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">compliance information about entities matching the filter
|
||||
<a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec" title="com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.FilterSpec</span></code></a>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
if the system reports an error while responding to the request.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
||||
association are not returned. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec" title="com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.FilterSpec</span></code></a>) – compliance status of matching entities for which information should
|
||||
be returned.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.list" title="com.vmware.vcenter.storage.policies_client.Compliance.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.Summary" title="com.vmware.vcenter.storage.policies_client.Compliance.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>compliance information about entities matching the filter
|
||||
<a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec" title="com.vmware.vcenter.storage.policies_client.Compliance.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.FilterSpec</span></code></a>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Compliance.FilterSpec.status</span></code> attribute contains a
|
||||
value that is not supported by the server.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||
value that is not supported by the server.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
if the system is unable to communicate with a service to complete
|
||||
the request.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
if the user can not be authenticated.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
if the user doesn’t have the required privileges.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
the request.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user can not be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user doesn’t have the required privileges.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -381,14 +375,11 @@ if the user doesn’t have the required privileges.</td>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.storage.policies_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.vcenter.storage.policies_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -397,48 +388,41 @@ if the user doesn’t have the required privileges.</td>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">VM</span></code> class provides methods managing the storage policy association
|
||||
for a virtual machine and its virtual disks. This class was added in
|
||||
vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.VM.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>vm_home=None</em>, <em>disks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.VM.Info" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">VM.Info</span></code> class contains information about a virtual machine and its
|
||||
virtual disks that are associated with the given storage policy. This class
|
||||
was added in vSphere API 6.7</p>
|
||||
was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>vm_home</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the virtual machine home is
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_home</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the virtual machine home is
|
||||
associated with the given storage policy. This attribute was added
|
||||
in vSphere API 6.7</li>
|
||||
<li><strong>disks</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>) – List of the virtual disks that are associated with the given
|
||||
storage policy. This attribute was added in vSphere API 6.7
|
||||
in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>disks</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>) – List of the virtual disks that are associated with the given
|
||||
storage policy. This attribute was added in vSphere API 6.7.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return a
|
||||
value of this class as a return value, the attribute will contain
|
||||
identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -446,45 +430,50 @@ identifiers for the resource type:
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>policy</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.VM.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about the virtual machines and/or their virtual
|
||||
disks that are associated with the given storage policy. This method
|
||||
was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – storage policy identifier.
|
||||
was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – storage policy identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.VM.Info" title="com.vmware.vcenter.storage.policies_client.VM.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Info</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Information about the virtual machines and/or their virtual disks
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.storage.policies_client.VM.Info" title="com.vmware.vcenter.storage.policies_client.VM.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about the virtual machines and/or their virtual disks
|
||||
that are associated with the given storage policy.
|
||||
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||
if there is no policy associated with <code class="docutils literal notranslate"><span class="pre">policy</span></code> in the system.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||||
if there is no policy associated with <code class="docutils literal notranslate"><span class="pre">policy</span></code> in the system.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
||||
if more than 1000 virtual machines are associated with the
|
||||
specified policy.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
if the user cannot be authenticated.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||
specified policy.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user cannot be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
if the system is unable to communicate with a service necessary to
|
||||
complete the request.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
complete the request.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the backend server encounters some an error while processing the
|
||||
request.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
if the user does not have the required priveleges.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
request.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have the required priveleges.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -503,7 +492,7 @@ if the user does not have the required priveleges.</td>
|
||||
<a href="com.vmware.vcenter.storage.policies.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.storage.policies package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.hvc.links.html" class="btn btn-neutral" title="com.vmware.vcenter.hvc.links package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vcenter.hvc.links.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.hvc.links package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -512,7 +501,7 @@ if the user does not have the required priveleges.</td>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -529,33 +518,16 @@ if the user does not have the required priveleges.</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.storage.policies package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vcenter.storage.policies package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -28,12 +35,8 @@
|
||||
<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" />
|
||||
<link rel="next" title="com.vmware.vcenter.vm package" href="com.vmware.vcenter.vm.html" />
|
||||
<link rel="next" title="com.vmware.vcenter.system_config package" href="com.vmware.vcenter.system_config.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.storage package" href="com.vmware.vcenter.storage.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -184,14 +187,11 @@
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.storage.policies.compliance_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.vcenter.storage.policies.compliance_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -199,49 +199,42 @@
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.storage.policies.compliance_client.</code><code class="descname">VM</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies.compliance_client.VM" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">VM</span></code> class provides methods related to query virtual machines of
|
||||
given compliance statuses. This class was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
given compliance statuses. This class was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec">
|
||||
<em class="property">class </em><code class="descname">FilterSpec</code><span class="sig-paren">(</span><em>status=None</em>, <em>vms=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code> class contains Status used to filter the results when
|
||||
listing virtual machines (see <a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.list" title="com.vmware.vcenter.storage.policies.compliance_client.VM.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">VM.list()</span></code></a>). This class was added in
|
||||
vSphere API 6.7</p>
|
||||
vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status" title="com.vmware.vcenter.storage.policies.compliance_client.VM.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Status</span></code></a>) – Compliance Status that a virtual machine must have to match the
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status" title="com.vmware.vcenter.storage.policies.compliance_client.VM.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Status</span></code></a>) – Compliance Status that a virtual machine must have to match the
|
||||
filter. Atleast one status must be specified. This attribute was
|
||||
added in vSphere API 6.7</li>
|
||||
<li><strong>vms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – Identifiers of virtual machines that can match the filter. This
|
||||
attribute was added in vSphere API 6.7
|
||||
added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>vms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – Identifiers of virtual machines that can match the filter. This
|
||||
attribute was added in vSphere API 6.7.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>. When methods return a value of this class as a
|
||||
return value, the attribute will contain identifiers for the
|
||||
resource type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.
|
||||
If None or empty, virtual machines with any identifier matches the
|
||||
filter</li>
|
||||
filter</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -250,36 +243,32 @@ filter</li>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>Provides the compliance details of a virtual machine and its associated
|
||||
entities which match the given compliance statuses. This class was added in
|
||||
vSphere API 6.7</p>
|
||||
vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>vm_home</strong> (<a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status" title="com.vmware.vcenter.storage.policies.compliance_client.VM.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Status</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Compliance status of the virtual machine home. This attribute was
|
||||
added in vSphere API 6.7
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_home</strong> (<a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status" title="com.vmware.vcenter.storage.policies.compliance_client.VM.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Status</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Compliance status of the virtual machine home. This attribute was
|
||||
added in vSphere API 6.7.
|
||||
If None or empty, virtual machine home is not associated with a
|
||||
storage policy.</li>
|
||||
<li><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status" title="com.vmware.vcenter.storage.policies.compliance_client.VM.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Status</span></code></a>) – A Map of virtual disks and their compliance status If empty, the
|
||||
storage policy.</p></li>
|
||||
<li><p><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status" title="com.vmware.vcenter.storage.policies.compliance_client.VM.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Status</span></code></a>) – A Map of virtual disks and their compliance status If empty, the
|
||||
virtual machine does not have any disks or its disks are not
|
||||
associated with a storage policy. This attribute was added in
|
||||
vSphere API 6.7
|
||||
vSphere API 6.7.
|
||||
When clients pass a value of this class as a parameter, the key in
|
||||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
|
||||
a value of this class as a return value, the key in the attribute
|
||||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -288,10 +277,10 @@ a value of this class as a return value, the key in the attribute
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The {\@Status} class defines he valid compliance status values for a
|
||||
virtual machine or virtual disk. This enumeration was added in vSphere API
|
||||
6.7</p>
|
||||
6.7.</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">This class represents an enumerated type in the interface language
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. 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
|
||||
@ -299,26 +288,23 @@ enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.storage.policies.compliance_client.VM.Status.COMPLIANT">
|
||||
<code class="descname">COMPLIANT</code><em class="property"> = Status(string='COMPLIANT')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status.COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The virtual machine or virtual disk is in compliance. This class attribute
|
||||
was added in vSphere API 6.7</p>
|
||||
was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.storage.policies.compliance_client.VM.Status.NON_COMPLIANT">
|
||||
<code class="descname">NON_COMPLIANT</code><em class="property"> = Status(string='NON_COMPLIANT')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status.NON_COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The virtual machine or virtual disk is in not in compliance. This class
|
||||
attribute was added in vSphere API 6.7</p>
|
||||
attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
@ -327,7 +313,7 @@ attribute was added in vSphere API 6.7</p>
|
||||
<dd><p>Compliance computation is not applicable for this virtual machine or disk
|
||||
because it does not have any storage requirement that apply to the
|
||||
object-based datastore on which the entity is placed. This class attribute
|
||||
was added in vSphere API 6.7</p>
|
||||
was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
@ -336,14 +322,14 @@ was added in vSphere API 6.7</p>
|
||||
<dd><p>Compliance status becomes out of date when the profile associated with the
|
||||
virtual machine or disk is edited and not applied. The compliance status
|
||||
will remain out of date until the latest policy is applied. This class
|
||||
attribute was added in vSphere API 6.7</p>
|
||||
attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.storage.policies.compliance_client.VM.Status.UNKNOWN_COMPLIANCE">
|
||||
<code class="descname">UNKNOWN_COMPLIANCE</code><em class="property"> = Status(string='UNKNOWN_COMPLIANCE')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status.UNKNOWN_COMPLIANCE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Compliance status of the virtual machine or virtual disk is not known. This
|
||||
class attribute was added in vSphere API 6.7</p>
|
||||
class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -355,47 +341,53 @@ class attribute was added in vSphere API 6.7</p>
|
||||
matching the filter <a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec" title="com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a>. If there are no virtual
|
||||
machines matching the <a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec" title="com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a> an empty List is returned.
|
||||
Virtual machines without storage policy association are not returned.
|
||||
This method was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec" title="com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a>) – compliance status of matching virtual machines for which
|
||||
information should be returned.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Info" title="com.vmware.vcenter.storage.policies.compliance_client.VM.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Info</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">compliance information about virtual machines matching the filter
|
||||
This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec" title="com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a>) – compliance status of matching virtual machines for which
|
||||
information should be returned.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Info" title="com.vmware.vcenter.storage.policies.compliance_client.VM.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>compliance information about virtual machines matching the filter
|
||||
<a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec" title="com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a>.
|
||||
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
if the system reports an error while responding to the request.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
||||
the resource type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||||
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">VM.FilterSpec.status</span></code> attribute contains a value that
|
||||
is not supported by the server.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||
is not supported by the server.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
if the system is unable to communicate with a service to complete
|
||||
the request.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
if the user can not be authenticated.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
if the user does not have the required privileges.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code>
|
||||
the request.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user can not be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have the required privileges.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
||||
if the API is invoked against vCenter Server version is less than
|
||||
6.5</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
||||
If more than 1000 results match the <a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec" title="com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
6.5</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
||||
If more than 1000 results match the <a class="reference internal" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec" title="com.vmware.vcenter.storage.policies.compliance_client.VM.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VM.FilterSpec</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -411,10 +403,10 @@ If more than 1000 results match the <a class="reference internal" href="#com.vmw
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="com.vmware.vcenter.vm.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.vm package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
<a href="com.vmware.vcenter.system_config.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.system_config package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.storage.html" class="btn btn-neutral" title="com.vmware.vcenter.storage package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vcenter.storage.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.storage package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -423,7 +415,7 @@ If more than 1000 results match the <a class="reference internal" href="#com.vmw
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -440,33 +432,16 @@ If more than 1000 results match the <a class="reference internal" href="#com.vmw
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
252
vsphere/cloud/com.vmware.vcenter.system_config.features.html
Normal file
252
vsphere/cloud/com.vmware.vcenter.system_config.features.html
Normal file
@ -0,0 +1,252 @@
|
||||
|
||||
|
||||
<!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>com.vmware.vcenter.system_config.features package — vSphere Automation SDK for Python. 6.8.7 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" />
|
||||
<link rel="next" title="com.vmware.vcenter.vcha package" href="com.vmware.vcenter.vcha.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.system_config package" href="com.vmware.vcenter.system_config.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"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
</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 class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><a href="com.html">com package</a> »</li>
|
||||
|
||||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||||
|
||||
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> »</li>
|
||||
|
||||
<li><a href="com.vmware.vcenter.system_config.html">com.vmware.vcenter.system_config package</a> »</li>
|
||||
|
||||
<li>com.vmware.vcenter.system_config.features package</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/com.vmware.vcenter.system_config.features.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="module-com.vmware.vcenter.system_config.features">
|
||||
<span id="com-vmware-vcenter-system-config-features-package"></span><h1>com.vmware.vcenter.system_config.features package<a class="headerlink" href="#module-com.vmware.vcenter.system_config.features" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vcenter.system_config.features.tech_preview_client">
|
||||
<span id="com-vmware-vcenter-system-config-features-tech-preview-client-module"></span><h2>com.vmware.vcenter.system_config.features.tech_preview_client module<a class="headerlink" href="#module-com.vmware.vcenter.system_config.features.tech_preview_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The {\@name com.vmware.vcenter.system-config.features.tech_preview} module
|
||||
provides classes for managing the status of Tech Preview features on the
|
||||
appliance.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.system_config.features.tech_preview_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.system_config.features.tech_preview_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.vcenter.system_config.features.tech_preview_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="com.vmware.vcenter.vcha.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.vcha package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.system_config.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.system_config package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<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>
|
||||
241
vsphere/cloud/com.vmware.vcenter.system_config.html
Normal file
241
vsphere/cloud/com.vmware.vcenter.system_config.html
Normal file
@ -0,0 +1,241 @@
|
||||
|
||||
|
||||
<!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>com.vmware.vcenter.system_config package — vSphere Automation SDK for Python. 6.8.7 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" />
|
||||
<link rel="next" title="com.vmware.vcenter.system_config.features package" href="com.vmware.vcenter.system_config.features.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.storage.policies package" href="com.vmware.vcenter.storage.policies.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"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
</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 class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><a href="com.html">com package</a> »</li>
|
||||
|
||||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||||
|
||||
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> »</li>
|
||||
|
||||
<li>com.vmware.vcenter.system_config package</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/com.vmware.vcenter.system_config.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="module-com.vmware.vcenter.system_config">
|
||||
<span id="com-vmware-vcenter-system-config-package"></span><h1>com.vmware.vcenter.system_config package<a class="headerlink" href="#module-com.vmware.vcenter.system_config" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="subpackages">
|
||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html">com.vmware.vcenter.system_config.features package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#module-com.vmware.vcenter.system_config.features.tech_preview_client">com.vmware.vcenter.system_config.features.tech_preview_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="com.vmware.vcenter.system_config.features.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.system_config.features package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.storage.policies.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.storage.policies package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<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>
|
||||
1000
vsphere/cloud/com.vmware.vcenter.vcha.html
Normal file
1000
vsphere/cloud/com.vmware.vcenter.vcha.html
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.vm.storage package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>com.vmware.vcenter.vm.storage package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -28,12 +35,8 @@
|
||||
<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" />
|
||||
<link rel="next" title="com.vmware.vcenter.vm_template package" href="com.vmware.vcenter.vm_template.html" />
|
||||
<link rel="next" title="vmware package" href="vmware.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.vm.hardware package" href="com.vmware.vcenter.vm.hardware.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -92,6 +94,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -114,7 +117,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -186,37 +189,32 @@
|
||||
<p>The Compliance class provides methods that return the compliance status of
|
||||
virtual machine entities(virtual machine home directory and virtual disks)
|
||||
that specify storage policy requirements. This class was added in vSphere
|
||||
API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.Compliance.CheckSpec">
|
||||
<em class="property">class </em><code class="descname">CheckSpec</code><span class="sig-paren">(</span><em>vm_home=None</em>, <em>disks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.CheckSpec" 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>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Compliance.CheckSpec</span></code> class contains attributes used to specify the
|
||||
entities on which the storage policy compliance check is to be invoked.
|
||||
This class was added in vSphere API 6.7</p>
|
||||
This class was added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>vm_home</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Invoke compliance check on the virtual machine home directory if
|
||||
set to true. This attribute was added in vSphere API 6.7</li>
|
||||
<li><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – Identifiers of the virtual machine’s virtual disks for which
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm_home</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Invoke compliance check on the virtual machine home directory if
|
||||
set to true. This attribute was added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – Identifiers of the virtual machine’s virtual disks for which
|
||||
compliance should be checked. This attribute was added in vSphere
|
||||
API 6.7
|
||||
API 6.7.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must contain identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return a
|
||||
@ -224,12 +222,10 @@ value of this class as a return value, the attribute will contain
|
||||
identifiers for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.
|
||||
If None or empty, compliance check is invoked on all the associated
|
||||
disks.</li>
|
||||
disks.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -239,38 +235,34 @@ disks.</li>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Compliance.Info</span></code> class contains information about the storage policy
|
||||
compliance of a virtual machine, including information about it’s home
|
||||
directory and/or it’s virtual disks. This class was added in vSphere API
|
||||
6.7</p>
|
||||
6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>overall_compliance</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Status" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Status</span></code></a>) – The overall compliance status of the virtual machine and all it’s
|
||||
entities. This attribute was added in vSphere API 6.7</li>
|
||||
<li><strong>vm_home</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.VmComplianceInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The storage policy compliance information
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>overall_compliance</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Status" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Status</span></code></a>) – The overall compliance status of the virtual machine and all it’s
|
||||
entities. This attribute was added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>vm_home</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.VmComplianceInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The storage policy compliance information
|
||||
<a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.VmComplianceInfo</span></code></a> for the virtual machine’s home
|
||||
directory. This attribute was added in vSphere API 6.7
|
||||
directory. This attribute was added in vSphere API 6.7.
|
||||
If None the virtual machine home directory has no storage policy
|
||||
association.</li>
|
||||
<li><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.VmComplianceInfo</span></code></a>) – The compliance information <a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.VmComplianceInfo</span></code></a> for
|
||||
association.</p></li>
|
||||
<li><p><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.VmComplianceInfo</span></code></a>) – The compliance information <a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.VmComplianceInfo</span></code></a> for
|
||||
the virtual machine’s virtual disks that are currently associated
|
||||
with a storage policy. This attribute was added in vSphere API 6.7
|
||||
with a storage policy. This attribute was added in vSphere API 6.7.
|
||||
When clients pass a value of this class as a parameter, the key in
|
||||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
|
||||
a value of this class as a return value, the key in the attribute
|
||||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</li>
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
@ -279,10 +271,10 @@ a value of this class as a return value, the key in the attribute
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Compliance.Status</span></code> class defines the storage compliance status of a
|
||||
virtual machine and its applicable entities. This enumeration was added in
|
||||
vSphere API 6.7</p>
|
||||
vSphere API 6.7.</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">This class represents an enumerated type in the interface language
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language
|
||||
definition. 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
|
||||
@ -290,25 +282,22 @@ enumerated type in communication with a server that supports the newer
|
||||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||||
type description page</span></a>.</p>
|
||||
</div>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.Compliance.Status.COMPLIANT">
|
||||
<code class="descname">COMPLIANT</code><em class="property"> = Status(string='COMPLIANT')</em><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Status.COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entity is in compliance. This class attribute was added in vSphere API 6.7</p>
|
||||
<dd><p>Entity is in compliance. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.Compliance.Status.NON_COMPLIANT">
|
||||
<code class="descname">NON_COMPLIANT</code><em class="property"> = Status(string='NON_COMPLIANT')</em><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Status.NON_COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Entity is out of compliance. This class attribute was added in vSphere API
|
||||
6.7</p>
|
||||
6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
@ -316,7 +305,7 @@ type description page</span></a>.</p>
|
||||
<code class="descname">NOT_APPLICABLE</code><em class="property"> = Status(string='NOT_APPLICABLE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Status.NOT_APPLICABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Compliance computation is not applicable for this entity because it does
|
||||
not have any storage requirements that apply to the datastore on which it
|
||||
is placed. This class attribute was added in vSphere API 6.7</p>
|
||||
is placed. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
@ -325,14 +314,14 @@ is placed. This class attribute was added in vSphere API 6.7</p>
|
||||
<dd><p>The Compliance status becomes out-of-date when the profile associated with
|
||||
the entity is edited but not applied. The compliance status remains
|
||||
out-of-date until the edited policy is applied to the entity. This class
|
||||
attribute was added in vSphere API 6.7</p>
|
||||
attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.Compliance.Status.UNKNOWN_COMPLIANCE">
|
||||
<code class="descname">UNKNOWN_COMPLIANCE</code><em class="property"> = Status(string='UNKNOWN_COMPLIANCE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Status.UNKNOWN_COMPLIANCE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Compliance status of the entity is not known. This class attribute was
|
||||
added in vSphere API 6.7</p>
|
||||
added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -343,23 +332,21 @@ added in vSphere API 6.7</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>The <code class="docutils literal notranslate"><span class="pre">Compliance.VmComplianceInfo</span></code> class contains information about
|
||||
storage policy compliance associated with a virtual machine. This class was
|
||||
added in vSphere API 6.7</p>
|
||||
added in vSphere API 6.7.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="first admonition-title">Tip</p>
|
||||
<p class="last">The arguments are used to initialize data attributes with the same
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>The arguments are used to initialize data attributes with the same
|
||||
names.</p>
|
||||
</div>
|
||||
<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>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Status" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Status</span></code></a>) – Status of the compliance operation. This attribute was added in
|
||||
vSphere API 6.7</li>
|
||||
<li><strong>check_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Date and time of the most recent compliance check. This attribute
|
||||
was added in vSphere API 6.7</li>
|
||||
<li><strong>policy</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>) – Identifier of the storage policy associated with the virtual
|
||||
machine. This attribute was added in vSphere API 6.7
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Status" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Status</span></code></a>) – Status of the compliance operation. This attribute was added in
|
||||
vSphere API 6.7.</p></li>
|
||||
<li><p><strong>check_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Date and time of the most recent compliance check. This attribute
|
||||
was added in vSphere API 6.7.</p></li>
|
||||
<li><p><strong>policy</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>) – Identifier of the storage policy associated with the virtual
|
||||
machine. This attribute was added in vSphere API 6.7.
|
||||
When clients pass a value of this class as a parameter, the
|
||||
attribute must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
|
||||
@ -368,16 +355,14 @@ identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.
|
||||
If None SPBM is unable to retrieve or determine the associated
|
||||
policy, <code class="xref py py-attr docutils literal notranslate"><span class="pre">Compliance.VmComplianceInfo.failure_cause</span></code> is set in
|
||||
such casses.</li>
|
||||
<li><strong>failure_cause</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The exception that caused the compliance check to fail. There can
|
||||
such casses.</p></li>
|
||||
<li><p><strong>failure_cause</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The exception that caused the compliance check to fail. There can
|
||||
be more than one cause, since a policy can contain capabilities
|
||||
from multiple providers. If empty, it implies no failures while
|
||||
retrieving compliance. This attribute was added in vSphere API 6.7</li>
|
||||
retrieving compliance. This attribute was added in vSphere API 6.7.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -385,90 +370,89 @@ retrieving compliance. This attribute was added in vSphere API 6.7</li>
|
||||
<code class="descname">check</code><span class="sig-paren">(</span><em>vm</em>, <em>check_spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the storage policy Compliance <a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Info" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Info</span></code></a> of a
|
||||
virtual machine after explicitly re-computing compliance check. This
|
||||
method was added in vSphere API 6.7</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>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
||||
method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
||||
<li><strong>check_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.CheckSpec" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.CheckSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.CheckSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parameter specifies the entities on which storage policy compliance
|
||||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
||||
<li><p><strong>check_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.CheckSpec" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.CheckSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.CheckSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parameter specifies the entities on which storage policy compliance
|
||||
check is to be invoked. The storage compliance Info
|
||||
<a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Info" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Info</span></code></a> is returned.
|
||||
If None, the behavior is equivalent to a
|
||||
<a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.CheckSpec" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.CheckSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.CheckSpec</span></code></a> with CheckSpec#vmHome set to true and
|
||||
CheckSpec#disks populated with all disks attached to the virtual
|
||||
machine.</li>
|
||||
machine.</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Info" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Virtual machine storage policy compliance <code class="docutils literal notranslate"><span class="pre">Compliance.Info</span></code> class
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Info" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Virtual machine storage policy compliance <code class="docutils literal notranslate"><span class="pre">Compliance.Info</span></code> class
|
||||
.
|
||||
If None, neither the virtual machine home directory nor any of it’s
|
||||
virtual disks are associated with a storage policy.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
if the system is unable to communicate with a service necessary to
|
||||
complete the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user cannot be authenticated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.Unauthorized</span></code>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have the required privileges.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.Compliance.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the cached storage policy compliance information of a virtual
|
||||
machine. This method was added in vSphere API 6.7</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
||||
machine. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Info" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Virtual machine storage policy compliance Info
|
||||
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Info" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Virtual machine storage policy compliance Info
|
||||
<a class="reference internal" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Info" title="com.vmware.vcenter.vm.storage.policy_client.Compliance.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance.Info</span></code></a>.
|
||||
If None, neither the virtual machine home directory nor any of it’s
|
||||
virtual disks are associated with a storage policy.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||||
if the system reports an error while responding to the request.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||
virtual disks are associated with a storage policy.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||||
if the system reports an error while responding to the request.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||||
if the system is unable to communicate with a service to complete
|
||||
the request.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||||
if the user cannot be authenticated.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||
if the user does not have the required privileges.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
the request.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raise</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||||
if the user cannot be authenticated.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raise</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||||
if the user does not have the required privileges.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -478,14 +462,11 @@ if the user does not have the required privileges.</td>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.storage.policy_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.vcenter.vm.storage.policy_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -499,10 +480,10 @@ if the user does not have the required privileges.</td>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="com.vmware.vcenter.vm_template.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.vm_template package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
<a href="vmware.html" class="btn btn-neutral float-right" title="vmware package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.vm.hardware.html" class="btn btn-neutral" title="com.vmware.vcenter.vm.hardware package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vcenter.vm.hardware.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.vm.hardware package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -511,7 +492,7 @@ if the user does not have the required privileges.</td>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -528,33 +509,16 @@ if the user does not have the required privileges.</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Interface definition language to python mapping for enumerated types — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>Interface definition language to python mapping for enumerated types — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -28,10 +35,6 @@
|
||||
<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" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -39,14 +42,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -56,7 +58,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -98,7 +100,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -158,25 +160,24 @@ language. The special class contains class attributes which represent
|
||||
the values of the enumerated type.</p>
|
||||
<p>This documentation explains the following:</p>
|
||||
<ul class="simple">
|
||||
<li>How the class variables are defined in the module. This specifies the names that you can use in your program.</li>
|
||||
<li>How you instantiate a class to use it for communication with future versions of the service.</li>
|
||||
<li><p>How the class variables are defined in the module. This specifies the names that you can use in your program.</p></li>
|
||||
<li><p>How you instantiate a class to use it for communication with future versions of the service.</p></li>
|
||||
</ul>
|
||||
<div class="section" id="example-of-an-enumerated-type-documentation">
|
||||
<h2>Example of an enumerated type documentation<a class="headerlink" href="#example-of-an-enumerated-type-documentation" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="docutils">
|
||||
<dt><em>class</em> com.vmware.vapi.metadata_client. <strong>SourceType</strong> (string)</dt>
|
||||
<dd><p class="first">Bases: vmware.vapi.bindings.enum.Enum</p>
|
||||
<dl>
|
||||
<dt><em>class</em> com.vmware.vapi.metadata_client. <strong>SourceType</strong> (string)</dt><dd><p>Bases: vmware.vapi.bindings.enum.Enum</p>
|
||||
<p>Metadata source type</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See <a class="reference internal" href="#enumeration-description"><span class="std std-ref">enumerated type description page</span></a>.</p>
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See <a class="reference internal" href="#enumeration-description"><span class="std std-ref">enumerated type description page</span></a>.</p>
|
||||
</div>
|
||||
<p><strong>Parameters</strong> : <strong>string</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>) – String value for the SourceType instance.</p>
|
||||
<dl class="last docutils">
|
||||
<dt><strong>FILE</strong> = <em>SourceType(string=’FILE’)</em></dt>
|
||||
<dd>If the source is backed by a file.</dd>
|
||||
<dt><strong>REMOTE</strong> = <em>SourceType(string=’REMOTE’)</em></dt>
|
||||
<dd>If the source is backed by a remote service.</dd>
|
||||
<dl class="simple">
|
||||
<dt><strong>FILE</strong> = <em>SourceType(string=’FILE’)</em></dt><dd><p>If the source is backed by a file.</p>
|
||||
</dd>
|
||||
<dt><strong>REMOTE</strong> = <em>SourceType(string=’REMOTE’)</em></dt><dd><p>If the source is backed by a remote service.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
@ -186,7 +187,7 @@ the values of the enumerated type.</p>
|
||||
<p>The enumerated type classes are defined in python modules that your code
|
||||
imports. You can use these in your code.</p>
|
||||
<ol class="arabic simple">
|
||||
<li>If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class.</li>
|
||||
<li><p>If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class.</p></li>
|
||||
</ol>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># SourceType is an enumerated type</span>
|
||||
<span class="kn">from</span> <span class="nn">com.vmware.vapi.metadata_client</span> <span class="kn">import</span> <span class="n">SourceType</span>
|
||||
@ -197,7 +198,7 @@ imports. You can use these in your code.</p>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ol class="arabic simple" start="2">
|
||||
<li>When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values.</li>
|
||||
<li><p>When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values.</p></li>
|
||||
</ol>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># SourceType is an enumerated type</span>
|
||||
<span class="kn">from</span> <span class="nn">com.vmware.vapi.metadata_client</span> <span class="kn">import</span> <span class="n">SourceType</span>
|
||||
@ -213,7 +214,7 @@ imports. You can use these in your code.</p>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ol class="arabic simple" start="3">
|
||||
<li>Sending a new enumerated type value to a server that has a newer version of the enumerated type.</li>
|
||||
<li><p>Sending a new enumerated type value to a server that has a newer version of the enumerated type.</p></li>
|
||||
</ol>
|
||||
<p>To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate the
|
||||
enumerated type class.</p>
|
||||
@ -239,7 +240,7 @@ enumerated type class.</p>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -256,33 +257,16 @@ enumerated type class.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Welcome to vSphere Automation SDK for Python’s documentation! — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>Welcome to vSphere Automation SDK for Python.’s documentation! — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -29,10 +36,6 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com package" href="com.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -40,14 +43,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="#" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="#" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -57,7 +59,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -99,7 +101,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="#">vSphere Automation SDK for Python</a>
|
||||
<a href="#">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -130,7 +132,7 @@
|
||||
|
||||
<li><a href="#">Docs</a> »</li>
|
||||
|
||||
<li>Welcome to vSphere Automation SDK for Python’s documentation!</li>
|
||||
<li>Welcome to vSphere Automation SDK for Python.’s documentation!</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
@ -150,7 +152,7 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="welcome-to-vsphere-automation-sdk-for-python-s-documentation">
|
||||
<h1>Welcome to vSphere Automation SDK for Python’s documentation!<a class="headerlink" href="#welcome-to-vsphere-automation-sdk-for-python-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<h1>Welcome to vSphere Automation SDK for Python.’s documentation!<a class="headerlink" href="#welcome-to-vsphere-automation-sdk-for-python-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
@ -163,6 +165,7 @@
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.appliance.networking.html">com.vmware.appliance.networking package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.networking.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.dns_client">com.vmware.appliance.networking.dns_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.firewall_client">com.vmware.appliance.networking.firewall_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.interfaces_client">com.vmware.appliance.networking.interfaces_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -228,6 +231,19 @@
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.library.html#module-com.vmware.content.library.item_client">com.vmware.content.library.item_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.content.type.html">com.vmware.content.type package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.type.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.content.type.ovf.html">com.vmware.content.type.ovf package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.content.type.ovf.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.content.type.ovf.html#module-com.vmware.content.type.ovf.policy_client">com.vmware.content.type.ovf.policy_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.type.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.content.type.html#module-com.vmware.content.type.ovf_client">com.vmware.content.type.ovf_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.content.html#submodules">Submodules</a></li>
|
||||
@ -263,15 +279,25 @@
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.privilege_client">com.vmware.vapi.metadata.privilege_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vapi.std.html">com.vmware.vapi.std package</a></li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vapi.std.html">com.vmware.vapi.std package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.std.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.errors_client">com.vmware.vapi.std.errors_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.html#module-com.vmware.vapi.metadata_client">com.vmware.vapi.metadata_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.html#module-com.vmware.vapi.std_client">com.vmware.vapi.std_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.html">com.vmware.vcenter package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html">com.vmware.vcenter.certificate_management package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#module-com.vmware.vcenter.certificate_management.vcenter_client">com.vmware.vcenter.certificate_management.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.compute.html">com.vmware.vcenter.compute package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html">com.vmware.vcenter.compute.policies package</a><ul>
|
||||
@ -327,6 +353,22 @@
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.storage.html#module-com.vmware.vcenter.storage.policies_client">com.vmware.vcenter.storage.policies_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.system_config.html">com.vmware.vcenter.system_config package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.system_config.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html">com.vmware.vcenter.system_config.features package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#module-com.vmware.vcenter.system_config.features.tech_preview_client">com.vmware.vcenter.system_config.features.tech_preview_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.vcha.html">com.vmware.vcenter.vcha package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vcha.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vcha.html#module-com.vmware.vcenter.vcha.cluster_client">com.vmware.vcenter.vcha.cluster_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.vm.html">com.vmware.vcenter.vm package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html">com.vmware.vcenter.vm.hardware package</a><ul>
|
||||
@ -349,25 +391,26 @@
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.storage_client">com.vmware.vcenter.vm.storage_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.vm_template.html">com.vmware.vcenter.vm_template package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#module-com.vmware.vcenter.vm_template.library_items_client">com.vmware.vcenter.vm_template.library_items_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.certificate_management_client">com.vmware.vcenter.certificate_management_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.compute_client">com.vmware.vcenter.compute_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.datastore_client">com.vmware.vcenter.datastore_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.deployment_client">com.vmware.vcenter.deployment_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.guest_client">com.vmware.vcenter.guest_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.hvc_client">com.vmware.vcenter.hvc_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.identity_client">com.vmware.vcenter.identity_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.inventory_client">com.vmware.vcenter.inventory_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.iso_client">com.vmware.vcenter.iso_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.lcm_client">com.vmware.vcenter.lcm_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.ovf_client">com.vmware.vcenter.ovf_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.services_client">com.vmware.vcenter.services_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.storage_client">com.vmware.vcenter.storage_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.system_config_client">com.vmware.vcenter.system_config_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.tokenservice_client">com.vmware.vcenter.tokenservice_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.topology_client">com.vmware.vcenter.topology_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.vcha_client">com.vmware.vcenter.vcha_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.vm_client">com.vmware.vcenter.vm_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.html#module-com.vmware.vcenter.vm_template_client">com.vmware.vcenter.vm_template_client module</a></li>
|
||||
</ul>
|
||||
@ -378,6 +421,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -409,21 +453,9 @@
|
||||
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.security.html#module-vmware.vapi.security.user_password">vmware.vapi.security.user_password module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="vmware.vapi.stdlib.html">vmware.vapi.stdlib package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.stdlib.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l7"><a class="reference internal" href="vmware.vapi.stdlib.client.html">vmware.vapi.stdlib.client package</a><ul>
|
||||
<li class="toctree-l8"><a class="reference internal" href="vmware.vapi.stdlib.client.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="vmware.vapi.stdlib.client.html#module-vmware.vapi.stdlib.client.factories">vmware.vapi.stdlib.client.factories module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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#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-l5"><a class="reference internal" href="vmware.vapi.vsphere.html">vmware.vapi.vsphere package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.vsphere.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.vsphere.html#module-vmware.vapi.vsphere.client">vmware.vapi.vsphere.client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -444,9 +476,9 @@
|
||||
<div class="section" id="indices-and-tables">
|
||||
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
|
||||
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
|
||||
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
|
||||
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@ -468,7 +500,7 @@
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -485,33 +517,16 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Binary file not shown.
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Python Module Index — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>Python Module Index — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -31,10 +38,6 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -42,14 +45,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -59,7 +61,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -101,7 +103,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -165,522 +167,643 @@
|
||||
<td>
|
||||
<a href="com.html#module-com"><code class="xref">com</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
id="toggle-2" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<code class="xref">com</code></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.html#module-com.vmware"><code class="xref">com.vmware</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance"><code class="xref">com.vmware.appliance</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.access_client"><code class="xref">com.vmware.appliance.access_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.health_client"><code class="xref">com.vmware.appliance.health_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.local_accounts_client"><code class="xref">com.vmware.appliance.local_accounts_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.localaccounts_client"><code class="xref">com.vmware.appliance.localaccounts_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.logging_client"><code class="xref">com.vmware.appliance.logging_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.monitoring_client"><code class="xref">com.vmware.appliance.monitoring_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking"><code class="xref">com.vmware.appliance.networking</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.dns_client"><code class="xref">com.vmware.appliance.networking.dns_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.firewall_client"><code class="xref">com.vmware.appliance.networking.firewall_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.networking.html#module-com.vmware.appliance.networking.interfaces_client"><code class="xref">com.vmware.appliance.networking.interfaces_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.networking_client"><code class="xref">com.vmware.appliance.networking_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.ntp_client"><code class="xref">com.vmware.appliance.ntp_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery"><code class="xref">com.vmware.appliance.recovery</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup"><code class="xref">com.vmware.appliance.recovery.backup</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup.job_client"><code class="xref">com.vmware.appliance.recovery.backup.job_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup.system_name_client"><code class="xref">com.vmware.appliance.recovery.backup.system_name_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.backup_client"><code class="xref">com.vmware.appliance.recovery.backup_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.reconciliation_client"><code class="xref">com.vmware.appliance.recovery.reconciliation_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.recovery.html#module-com.vmware.appliance.recovery.restore_client"><code class="xref">com.vmware.appliance.recovery.restore_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.recovery_client"><code class="xref">com.vmware.appliance.recovery_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.shutdown_client"><code class="xref">com.vmware.appliance.shutdown_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.system.html#module-com.vmware.appliance.system"><code class="xref">com.vmware.appliance.system</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.system.html#module-com.vmware.appliance.system.time_client"><code class="xref">com.vmware.appliance.system.time_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.system_client"><code class="xref">com.vmware.appliance.system_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.tymesync_client"><code class="xref">com.vmware.appliance.tymesync_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.update_client"><code class="xref">com.vmware.appliance.update_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.appliance.html#module-com.vmware.appliance.vmon_client"><code class="xref">com.vmware.appliance.vmon_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.html#module-com.vmware.appliance_client"><code class="xref">com.vmware.appliance_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.cis.html#module-com.vmware.cis"><code class="xref">com.vmware.cis</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.cis.html#module-com.vmware.cis.tagging_client"><code class="xref">com.vmware.cis.tagging_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.cis.html#module-com.vmware.cis.task_client"><code class="xref">com.vmware.cis.task_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.html#module-com.vmware.cis_client"><code class="xref">com.vmware.cis_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.content.html#module-com.vmware.content"><code class="xref">com.vmware.content</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.content.library.html#module-com.vmware.content.library"><code class="xref">com.vmware.content.library</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.content.library.item.html#module-com.vmware.content.library.item"><code class="xref">com.vmware.content.library.item</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.downloadsession_client"><code class="xref">com.vmware.content.library.item.downloadsession_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.updatesession_client"><code class="xref">com.vmware.content.library.item.updatesession_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.content.library.html#module-com.vmware.content.library.item_client"><code class="xref">com.vmware.content.library.item_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.content.html#module-com.vmware.content.library_client"><code class="xref">com.vmware.content.library_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.content.type.html#module-com.vmware.content.type"><code class="xref">com.vmware.content.type</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.content.type.ovf.html#module-com.vmware.content.type.ovf"><code class="xref">com.vmware.content.type.ovf</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.content.type.ovf.html#module-com.vmware.content.type.ovf.policy_client"><code class="xref">com.vmware.content.type.ovf.policy_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.content.type.html#module-com.vmware.content.type.ovf_client"><code class="xref">com.vmware.content.type.ovf_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.html#module-com.vmware.content_client"><code class="xref">com.vmware.content_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.html#module-com.vmware.vapi"><code class="xref">com.vmware.vapi</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata"><code class="xref">com.vmware.vapi.metadata</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.metadata.authentication.html#module-com.vmware.vapi.metadata.authentication"><code class="xref">com.vmware.vapi.metadata.authentication</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.metadata.authentication.html#module-com.vmware.vapi.metadata.authentication.service_client"><code class="xref">com.vmware.vapi.metadata.authentication.service_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.authentication_client"><code class="xref">com.vmware.vapi.metadata.authentication_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.cli_client"><code class="xref">com.vmware.vapi.metadata.cli_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel"><code class="xref">com.vmware.vapi.metadata.metamodel</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.resource_client"><code class="xref">com.vmware.vapi.metadata.metamodel.resource_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.service_client"><code class="xref">com.vmware.vapi.metadata.metamodel.service_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.metamodel_client"><code class="xref">com.vmware.vapi.metadata.metamodel_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.metadata.privilege.html#module-com.vmware.vapi.metadata.privilege"><code class="xref">com.vmware.vapi.metadata.privilege</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.metadata.privilege.html#module-com.vmware.vapi.metadata.privilege.service_client"><code class="xref">com.vmware.vapi.metadata.privilege.service_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.privilege_client"><code class="xref">com.vmware.vapi.metadata.privilege_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.html#module-com.vmware.vapi.metadata_client"><code class="xref">com.vmware.vapi.metadata_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.std.html#module-com.vmware.vapi.std"><code class="xref">com.vmware.vapi.std</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.errors_client"><code class="xref">com.vmware.vapi.std.errors_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vapi.html#module-com.vmware.vapi.std_client"><code class="xref">com.vmware.vapi.std_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.html#module-com.vmware.vapi_client"><code class="xref">com.vmware.vapi_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter"><code class="xref">com.vmware.vcenter</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.certificate_management.html#module-com.vmware.vcenter.certificate_management"><code class="xref">com.vmware.vcenter.certificate_management</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.certificate_management.html#module-com.vmware.vcenter.certificate_management.vcenter_client"><code class="xref">com.vmware.vcenter.certificate_management.vcenter_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.certificate_management_client"><code class="xref">com.vmware.vcenter.certificate_management_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.compute.html#module-com.vmware.vcenter.compute"><code class="xref">com.vmware.vcenter.compute</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.compute.policies.html#module-com.vmware.vcenter.compute.policies"><code class="xref">com.vmware.vcenter.compute.policies</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities"><code class="xref">com.vmware.vcenter.compute.policies.capabilities</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client"><code class="xref">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client"><code class="xref">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client"><code class="xref">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client"><code class="xref">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client"><code class="xref">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.compute.policies.html#module-com.vmware.vcenter.compute.policies.capabilities_client"><code class="xref">com.vmware.vcenter.compute.policies.capabilities_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.compute.html#module-com.vmware.vcenter.compute.policies_client"><code class="xref">com.vmware.vcenter.compute.policies_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.compute_client"><code class="xref">com.vmware.vcenter.compute_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.datastore_client"><code class="xref">com.vmware.vcenter.datastore_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.deployment.html#module-com.vmware.vcenter.deployment"><code class="xref">com.vmware.vcenter.deployment</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.deployment.install.html#module-com.vmware.vcenter.deployment.install"><code class="xref">com.vmware.vcenter.deployment.install</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.deployment.install.initial_config.html#module-com.vmware.vcenter.deployment.install.initial_config"><code class="xref">com.vmware.vcenter.deployment.install.initial_config</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.deployment.install.initial_config.html#module-com.vmware.vcenter.deployment.install.initial_config.remote_psc_client"><code class="xref">com.vmware.vcenter.deployment.install.initial_config.remote_psc_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.deployment.install.html#module-com.vmware.vcenter.deployment.install.psc_client"><code class="xref">com.vmware.vcenter.deployment.install.psc_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.deployment.html#module-com.vmware.vcenter.deployment.install_client"><code class="xref">com.vmware.vcenter.deployment.install_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.deployment_client"><code class="xref">com.vmware.vcenter.deployment_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.guest_client"><code class="xref">com.vmware.vcenter.guest_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc"><code class="xref">com.vmware.vcenter.hvc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.hvc.links.html#module-com.vmware.vcenter.hvc.links"><code class="xref">com.vmware.vcenter.hvc.links</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.hvc.links.html#module-com.vmware.vcenter.hvc.links.sync_client"><code class="xref">com.vmware.vcenter.hvc.links.sync_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc.links_client"><code class="xref">com.vmware.vcenter.hvc.links_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc.management_client"><code class="xref">com.vmware.vcenter.hvc.management_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.hvc_client"><code class="xref">com.vmware.vcenter.hvc_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.identity_client"><code class="xref">com.vmware.vcenter.identity_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.inventory_client"><code class="xref">com.vmware.vcenter.inventory_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.iso_client"><code class="xref">com.vmware.vcenter.iso_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.lcm_client"><code class="xref">com.vmware.vcenter.lcm_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.ovf_client"><code class="xref">com.vmware.vcenter.ovf_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.services_client"><code class="xref">com.vmware.vcenter.services_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.storage.html#module-com.vmware.vcenter.storage"><code class="xref">com.vmware.vcenter.storage</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.storage.policies.html#module-com.vmware.vcenter.storage.policies"><code class="xref">com.vmware.vcenter.storage.policies</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.storage.policies.html#module-com.vmware.vcenter.storage.policies.compliance_client"><code class="xref">com.vmware.vcenter.storage.policies.compliance_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.storage.html#module-com.vmware.vcenter.storage.policies_client"><code class="xref">com.vmware.vcenter.storage.policies_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.storage_client"><code class="xref">com.vmware.vcenter.storage_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.system_config.html#module-com.vmware.vcenter.system_config"><code class="xref">com.vmware.vcenter.system_config</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.system_config.features.html#module-com.vmware.vcenter.system_config.features"><code class="xref">com.vmware.vcenter.system_config.features</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.system_config.features.html#module-com.vmware.vcenter.system_config.features.tech_preview_client"><code class="xref">com.vmware.vcenter.system_config.features.tech_preview_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.system_config_client"><code class="xref">com.vmware.vcenter.system_config_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.tokenservice_client"><code class="xref">com.vmware.vcenter.tokenservice_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.topology_client"><code class="xref">com.vmware.vcenter.topology_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vcha.html#module-com.vmware.vcenter.vcha"><code class="xref">com.vmware.vcenter.vcha</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vcha.html#module-com.vmware.vcenter.vcha.cluster_client"><code class="xref">com.vmware.vcenter.vcha.cluster_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.vcha_client"><code class="xref">com.vmware.vcenter.vcha_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm"><code class="xref">com.vmware.vcenter.vm</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.compute_client"><code class="xref">com.vmware.vcenter.vm.compute_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.guest_client"><code class="xref">com.vmware.vcenter.vm.guest_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware"><code class="xref">com.vmware.vcenter.vm.hardware</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.adapter_client"><code class="xref">com.vmware.vcenter.vm.hardware.adapter_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.boot_client"><code class="xref">com.vmware.vcenter.vm.hardware.boot_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.hardware_client"><code class="xref">com.vmware.vcenter.vm.hardware_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vm.storage.html#module-com.vmware.vcenter.vm.storage"><code class="xref">com.vmware.vcenter.vm.storage</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vm.storage.html#module-com.vmware.vcenter.vm.storage.policy_client"><code class="xref">com.vmware.vcenter.vm.storage.policy_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.storage_client"><code class="xref">com.vmware.vcenter.vm.storage_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.vm_client"><code class="xref">com.vmware.vcenter.vm_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vm_template.html#module-com.vmware.vcenter.vm_template"><code class="xref">com.vmware.vcenter.vm_template</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.vm_template.html#module-com.vmware.vcenter.vm_template.library_items_client"><code class="xref">com.vmware.vcenter.vm_template.library_items_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vcenter.html#module-com.vmware.vcenter.vm_template_client"><code class="xref">com.vmware.vcenter.vm_template_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.html#module-com.vmware.vcenter_client"><code class="xref">com.vmware.vcenter_client</code></a></td><td>
|
||||
@ -690,94 +813,85 @@
|
||||
<strong>v</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
id="toggle-2" style="display: none" alt="-" /></td>
|
||||
id="toggle-3" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<a href="vmware.html#module-vmware"><code class="xref">vmware</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
id="toggle-4" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<code class="xref">vmware</code></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.html#module-vmware.vapi"><code class="xref">vmware.vapi</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.html#module-vmware.vapi.core"><code class="xref">vmware.vapi.core</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.html#module-vmware.vapi.exception"><code class="xref">vmware.vapi.exception</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.lib.html#module-vmware.vapi.lib"><code class="xref">vmware.vapi.lib</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.lib.html#module-vmware.vapi.lib.connect"><code class="xref">vmware.vapi.lib.connect</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.html#module-vmware.vapi.message"><code class="xref">vmware.vapi.message</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.security.html#module-vmware.vapi.security"><code class="xref">vmware.vapi.security</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.security.client.html#module-vmware.vapi.security.client"><code class="xref">vmware.vapi.security.client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.security.client.html#module-vmware.vapi.security.client.security_context_filter"><code class="xref">vmware.vapi.security.client.security_context_filter</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.security.html#module-vmware.vapi.security.session"><code class="xref">vmware.vapi.security.session</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.security.html#module-vmware.vapi.security.sso"><code class="xref">vmware.vapi.security.sso</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.security.html#module-vmware.vapi.security.user_password"><code class="xref">vmware.vapi.security.user_password</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.stdlib.html#module-vmware.vapi.stdlib"><code class="xref">vmware.vapi.stdlib</code></a></td><td>
|
||||
<a href="vmware.vapi.vsphere.html#module-vmware.vapi.vsphere"><code class="xref">vmware.vapi.vsphere</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.stdlib.client.html#module-vmware.vapi.stdlib.client"><code class="xref">vmware.vapi.stdlib.client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.stdlib.client.html#module-vmware.vapi.stdlib.client.factories"><code class="xref">vmware.vapi.stdlib.client.factories</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></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>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter"><code class="xref">vmware.vapi.vmc.csp_filter</code></a></td><td>
|
||||
<a href="vmware.vapi.vsphere.html#module-vmware.vapi.vsphere.client"><code class="xref">vmware.vapi.vsphere.client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
</table>
|
||||
|
||||
@ -792,7 +906,7 @@
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -809,33 +923,16 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Search — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>Search — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,17 @@
|
||||
|
||||
|
||||
|
||||
<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/searchtools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
@ -28,10 +36,6 @@
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="#" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -39,14 +43,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -56,7 +59,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -98,7 +101,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -170,7 +173,7 @@
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -187,34 +190,16 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
||||
</script>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>vmware package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>vmware package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -29,11 +36,7 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="vmware.vapi package" href="vmware.vapi.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.vm_template package" href="com.vmware.vcenter.vm_template.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
<link rel="prev" title="com.vmware.vcenter.vm.storage package" href="com.vmware.vcenter.vm.storage.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -106,7 +108,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -184,21 +186,9 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.security.html#module-vmware.vapi.security.user_password">vmware.vapi.security.user_password module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="vmware.vapi.stdlib.html">vmware.vapi.stdlib package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.stdlib.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="vmware.vapi.stdlib.client.html">vmware.vapi.stdlib.client package</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.stdlib.client.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.stdlib.client.html#module-vmware.vapi.stdlib.client.factories">vmware.vapi.stdlib.client.factories module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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#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-l3"><a class="reference internal" href="vmware.vapi.vsphere.html">vmware.vapi.vsphere package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.vsphere.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.vsphere.html#module-vmware.vapi.vsphere.client">vmware.vapi.vsphere.client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -225,7 +215,7 @@
|
||||
<a href="vmware.vapi.html" class="btn btn-neutral float-right" title="vmware.vapi package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vcenter.vm_template.html" class="btn btn-neutral" title="com.vmware.vcenter.vm_template package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vcenter.vm.storage.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.vm.storage package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -234,7 +224,7 @@
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -251,33 +241,16 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>vmware.vapi.lib package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>vmware.vapi.lib package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="vmware.vapi.security package" href="vmware.vapi.security.html" />
|
||||
<link rel="prev" title="vmware.vapi package" href="vmware.vapi.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -113,7 +115,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -187,28 +189,24 @@
|
||||
<dt id="vmware.vapi.lib.connect.get_connector">
|
||||
<code class="descclassname">vmware.vapi.lib.connect.</code><code class="descname">get_connector</code><span class="sig-paren">(</span><em>rpc_provider_name</em>, <em>msg_protocol</em>, <em>ssl_context=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.lib.connect.get_connector" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a connection to the vAPI Provider using the specified arguments</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>rpc_provider_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The RPC provider to be used for the connection.
|
||||
Valid values are ‘http’, ‘https’ and ‘requests’</li>
|
||||
<li><strong>msg_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The message protocol to be used for the connection.
|
||||
Valid values are ‘json’.</li>
|
||||
<li><strong>ssl_context</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSSL.SSL.Context</span></code>) – SSL context to use for SSL connections</li>
|
||||
<li><strong>kwargs</strong> – Additional arguments for the RPC provider</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>rpc_provider_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The RPC provider to be used for the connection.
|
||||
Valid values are ‘http’, ‘https’ and ‘requests’</p></li>
|
||||
<li><p><strong>msg_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The message protocol to be used for the connection.
|
||||
Valid values are ‘json’.</p></li>
|
||||
<li><p><strong>ssl_context</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSSL.SSL.Context</span></code>) – SSL context to use for SSL connections</p></li>
|
||||
<li><p><strong>kwargs</strong> – Additional arguments for the RPC provider</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Connection to the vAPI provider</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Connection to the vAPI provider</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
@ -216,31 +214,27 @@ Valid values are ‘json’.</li>
|
||||
<code class="descclassname">vmware.vapi.lib.connect.</code><code class="descname">get_requests_connector</code><span class="sig-paren">(</span><em>session</em>, <em>msg_protocol='json'</em>, <em>url=None</em>, <em>timeout=None</em>, <em>pool_size=8</em>, <em>provider_filter_chain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.lib.connect.get_requests_connector" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a connection that uses ‘requests’ library for http(s) connections to
|
||||
a vAPI Provider.</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>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Session object</li>
|
||||
<li><strong>msg_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Message protocol to be used for the connection. Valid
|
||||
values are ‘json’.</li>
|
||||
<li><strong>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – HTTP(S) URL to be used</li>
|
||||
<li><strong>timeout</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Request timeout</li>
|
||||
<li><strong>pool_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Connection pool size to be used</li>
|
||||
<li><strong>provider_filter_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Session object</p></li>
|
||||
<li><p><strong>msg_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Message protocol to be used for the connection. Valid
|
||||
values are ‘json’.</p></li>
|
||||
<li><p><strong>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – HTTP(S) URL to be used</p></li>
|
||||
<li><p><strong>timeout</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Request timeout</p></li>
|
||||
<li><p><strong>pool_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Connection pool size to be used</p></li>
|
||||
<li><p><strong>provider_filter_chain</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.provider.filter.ApiProviderFilter</span></code>) – List of API filters in order they are to be
|
||||
chained</li>
|
||||
chained</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Connection to the vAPI provider</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Connection to the vAPI provider</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
@ -248,28 +242,24 @@ chained</li>
|
||||
<code class="descclassname">vmware.vapi.lib.connect.</code><code class="descname">get_requests_hok_connector</code><span class="sig-paren">(</span><em>session</em>, <em>msg_protocol='json'</em>, <em>url=None</em>, <em>timeout=None</em>, <em>pool_size=8</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.lib.connect.get_requests_hok_connector" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a connection that uses SAML Hok based authentication using ‘requests’
|
||||
library to connect to a vAPI Provider.</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>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Session object</li>
|
||||
<li><strong>msg_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Message protocol to be used for the connection. Valid
|
||||
values are ‘json’.</li>
|
||||
<li><strong>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – HTTP(S) URL to be used</li>
|
||||
<li><strong>timeout</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Request timeout</li>
|
||||
<li><strong>pool_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Connection pool size to be used</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Session object</p></li>
|
||||
<li><p><strong>msg_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Message protocol to be used for the connection. Valid
|
||||
values are ‘json’.</p></li>
|
||||
<li><p><strong>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – HTTP(S) URL to be used</p></li>
|
||||
<li><p><strong>timeout</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Request timeout</p></li>
|
||||
<li><p><strong>pool_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Connection pool size to be used</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Connection to the vAPI provider</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Connection to the vAPI provider</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
@ -277,28 +267,24 @@ values are ‘json’.</li>
|
||||
<code class="descclassname">vmware.vapi.lib.connect.</code><code class="descname">get_saml_hok_connector</code><span class="sig-paren">(</span><em>rpc_provider_name</em>, <em>msg_protocol='json'</em>, <em>ssl_context=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.lib.connect.get_saml_hok_connector" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a connection that uses SAML Hok based authentication
|
||||
to connect to a vAPI Provider</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>rpc_provider_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The RPC provider to be used for the connection.
|
||||
Valid values are ‘http’, ‘https’ or ‘requests’</li>
|
||||
<li><strong>msg_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The message protocol to be used for the connection.
|
||||
Valid values are ‘json’.</li>
|
||||
<li><strong>ssl_context</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSSL.SSL.Context</span></code>) – SSL context to use for SSL connections</li>
|
||||
<li><strong>kwargs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>) – Additional arguments for the RPC provider</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>rpc_provider_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The RPC provider to be used for the connection.
|
||||
Valid values are ‘http’, ‘https’ or ‘requests’</p></li>
|
||||
<li><p><strong>msg_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The message protocol to be used for the connection.
|
||||
Valid values are ‘json’.</p></li>
|
||||
<li><p><strong>ssl_context</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSSL.SSL.Context</span></code>) – SSL context to use for SSL connections</p></li>
|
||||
<li><p><strong>kwargs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>) – Additional arguments for the RPC provider</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Connection to the vAPI provider</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Connection to the vAPI provider</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -315,7 +301,7 @@ Valid values are ‘json’.</li>
|
||||
<a href="vmware.vapi.security.html" class="btn btn-neutral float-right" title="vmware.vapi.security package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="vmware.vapi.html" class="btn btn-neutral" title="vmware.vapi package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="vmware.vapi.html" class="btn btn-neutral float-left" title="vmware.vapi package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -324,7 +310,7 @@ Valid values are ‘json’.</li>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -341,33 +327,16 @@ Valid values are ‘json’.</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>vmware.vapi.security.client package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>vmware.vapi.security.client package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -28,12 +35,8 @@
|
||||
<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" />
|
||||
<link rel="next" title="vmware.vapi.stdlib package" href="vmware.vapi.stdlib.html" />
|
||||
<link rel="next" title="vmware.vapi.vsphere package" href="vmware.vapi.vsphere.html" />
|
||||
<link rel="prev" title="vmware.vapi.security package" href="vmware.vapi.security.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -113,7 +115,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -184,83 +186,72 @@
|
||||
<p>SecurityContextFilter in API Provider chain adds the security
|
||||
context to the execution context passed in.</p>
|
||||
<p>Initialize SecurityContextFilter</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||||
<li><strong>next_provider</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ApiProvider" title="vmware.vapi.core.ApiProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.ApiProvider</span></code></a>) – API Provider to invoke the requests</li>
|
||||
<li><strong>security_context</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a>) – Security context</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>next_provider</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ApiProvider" title="vmware.vapi.core.ApiProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.ApiProvider</span></code></a>) – API Provider to invoke the requests</p></li>
|
||||
<li><p><strong>security_context</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a>) – Security context</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.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.security.client.security_context_filter.LegacySecurityContextFilter.get_max_retries" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the max number of retries</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Number of retries</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Number of retries</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.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.security.client.security_context_filter.LegacySecurityContextFilter.get_security_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve the stored security context.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>on_error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether this method is called after getting an error</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Security context or None</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>on_error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether this method is called after getting an error</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Security context or None</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.set_security_context">
|
||||
<code class="descname">set_security_context</code><span class="sig-paren">(</span><em>security_context</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.set_security_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set security context</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>security_context</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a>) – Security context</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>security_context</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a>) – Security context</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.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.security.client.security_context_filter.LegacySecurityContextFilter.should_retry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns whether the request should be retried or not based on the error.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>error_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.ErrorValue</span></code>) – Method error</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns True if request should be retried based on the error
|
||||
value provided else False</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>error_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.ErrorValue</span></code>) – Method error</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Returns True if request should be retried based on the error
|
||||
value provided else False</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -272,28 +263,23 @@ value provided else False</td>
|
||||
<p>SecurityContextFilter in API Provider chain adds the security
|
||||
context to the execution context passed in.</p>
|
||||
<p>Initialize SecurityContextFilter</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>next_provider</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ApiProvider" title="vmware.vapi.core.ApiProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.ApiProvider</span></code></a>) – API Provider to invoke the requests</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>next_provider</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ApiProvider" title="vmware.vapi.core.ApiProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.ApiProvider</span></code></a>) – API Provider to invoke the requests</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="vmware.vapi.security.client.security_context_filter.SecurityContextFilter.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.security.client.security_context_filter.SecurityContextFilter.get_max_retries" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the max number of retries</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Number of retries</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Number of retries</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -302,63 +288,57 @@ context to the execution context passed in.</p>
|
||||
<dd><p>Retrieve security context. If this method is called after an error
|
||||
occured and the request needs to be retried, then a new security context
|
||||
may be created depending on the scheme.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>on_error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether this method is called after getting an error</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Security context</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>on_error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether this method is called after getting an error</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Security context</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="vmware.vapi.security.client.security_context_filter.SecurityContextFilter.invoke">
|
||||
<code class="descname">invoke</code><span class="sig-paren">(</span><em>service_id</em>, <em>operation_id</em>, <em>input_value</em>, <em>ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.client.security_context_filter.SecurityContextFilter.invoke" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Invoke an API request</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>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Service identifier</li>
|
||||
<li><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Operation identifier</li>
|
||||
<li><strong>input_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.StructValue</span></code>) – Method input parameters</li>
|
||||
<li><strong>ctx</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ExecutionContext" title="vmware.vapi.core.ExecutionContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.ExecutionContext</span></code></a>) – Execution context for this method</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Service identifier</p></li>
|
||||
<li><p><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Operation identifier</p></li>
|
||||
<li><p><strong>input_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.StructValue</span></code>) – Method input parameters</p></li>
|
||||
<li><p><strong>ctx</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ExecutionContext" title="vmware.vapi.core.ExecutionContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.ExecutionContext</span></code></a>) – Execution context for this method</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.MethodResult" title="vmware.vapi.core.MethodResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.MethodResult</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">Result of the method invocation</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.MethodResult" title="vmware.vapi.core.MethodResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.MethodResult</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Result of the method invocation</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="vmware.vapi.security.client.security_context_filter.SecurityContextFilter.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.security.client.security_context_filter.SecurityContextFilter.should_retry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns whether the request should be retried or not based on the error.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>error_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.ErrorValue</span></code>) – Method error</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns True if request should be retried based on the error
|
||||
value provided else False</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>error_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.ErrorValue</span></code>) – Method error</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Returns True if request should be retried based on the error
|
||||
value provided else False</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -374,10 +354,10 @@ value provided else False</td>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="vmware.vapi.stdlib.html" class="btn btn-neutral float-right" title="vmware.vapi.stdlib package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
<a href="vmware.vapi.vsphere.html" class="btn btn-neutral float-right" title="vmware.vapi.vsphere package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="vmware.vapi.security.html" class="btn btn-neutral" title="vmware.vapi.security package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="vmware.vapi.security.html" class="btn btn-neutral float-left" title="vmware.vapi.security package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -386,7 +366,7 @@ value provided else False</td>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -403,33 +383,16 @@ value provided else False</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>vmware.vapi.security package — vSphere Automation SDK for Python 6.8.1 documentation</title>
|
||||
<title>vmware.vapi.security package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="vmware.vapi.security.client package" href="vmware.vapi.security.client.html" />
|
||||
<link rel="prev" title="vmware.vapi.lib package" href="vmware.vapi.lib.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,14 +44,13 @@
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
||||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.1
|
||||
6.8.7
|
||||
</div>
|
||||
|
||||
|
||||
@ -113,7 +115,7 @@
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
@ -205,18 +207,17 @@ the session identifier.</p>
|
||||
if it is not present, then it will check in the HTTP headers.
|
||||
The session security context is created based on the first session
|
||||
identifier it finds.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>request</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">werkzeug.wrappers.Request</span></code>) – Request object</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Security context object</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>request</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">werkzeug.wrappers.Request</span></code>) – Request object</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Security context object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -226,18 +227,17 @@ identifier it finds.</p>
|
||||
<code class="descclassname">vmware.vapi.security.session.</code><code class="descname">create_session_security_context</code><span class="sig-paren">(</span><em>session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.session.create_session_security_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a security context for Session Id based authentication
|
||||
scheme</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Session ID</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Newly created security context</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Session ID</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Newly created security context</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -283,18 +283,17 @@ version of the object or raise a <code class="docutils literal notranslate"><spa
|
||||
<dt id="vmware.vapi.security.sso.JSONCanonicalEncoder.encode">
|
||||
<code class="descname">encode</code><span class="sig-paren">(</span><em>o</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.sso.JSONCanonicalEncoder.encode" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Encode a given python object</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>o</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>) – Python object</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">JSON string in canonicalized form</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>o</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>) – Python object</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>JSON string in canonicalized form</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -305,14 +304,13 @@ version of the object or raise a <code class="docutils literal notranslate"><spa
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>This class is responsible for transforming JSON messages into their
|
||||
canonical representation.</p>
|
||||
<dl class="docutils">
|
||||
<dt>The canonical form is defined by the following rules:</dt>
|
||||
<dd><ol class="first last arabic simple">
|
||||
<li>Non-significant(1) whitespace characters MUST NOT be used</li>
|
||||
<li>Non-significant(1) line endings MUST NOT be used</li>
|
||||
<li>Entries (set of name/value pairs) in JSON objects MUST be sorted
|
||||
lexicographically(2) by their names based on UCS codepoint values</li>
|
||||
<li>Arrays MUST preserve their initial ordering</li>
|
||||
<dl class="simple">
|
||||
<dt>The canonical form is defined by the following rules:</dt><dd><ol class="arabic simple">
|
||||
<li><p>Non-significant(1) whitespace characters MUST NOT be used</p></li>
|
||||
<li><p>Non-significant(1) line endings MUST NOT be used</p></li>
|
||||
<li><p>Entries (set of name/value pairs) in JSON objects MUST be sorted
|
||||
lexicographically(2) by their names based on UCS codepoint values</p></li>
|
||||
<li><p>Arrays MUST preserve their initial ordering</p></li>
|
||||
</ol>
|
||||
</dd>
|
||||
</dl>
|
||||
@ -322,36 +320,34 @@ lexicographically(2) by their names based on UCS codepoint values</li>
|
||||
<dt id="vmware.vapi.security.sso.JSONCanonicalizer.canonicalize">
|
||||
<em class="property">static </em><code class="descname">canonicalize</code><span class="sig-paren">(</span><em>input_message</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.sso.JSONCanonicalizer.canonicalize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Canonicalize the input message</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>input_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Input message</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Canonicalized message</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>input_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Input message</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Canonicalized message</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="staticmethod">
|
||||
<dt id="vmware.vapi.security.sso.JSONCanonicalizer.canonicalize_py_obj">
|
||||
<em class="property">static </em><code class="descname">canonicalize_py_obj</code><span class="sig-paren">(</span><em>py_obj</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.sso.JSONCanonicalizer.canonicalize_py_obj" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Canonicalize the input python object</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>input_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>) – Input python object</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Canonicalized message</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>input_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>) – Input python object</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Canonicalized message</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -371,10 +367,11 @@ context. A timestamp is also added to guard against replay attacks</p>
|
||||
<p>Sample input security context:
|
||||
{</p>
|
||||
<blockquote>
|
||||
<div>‘schemeId’: ‘SAML_TOKEN’,
|
||||
<div><p>‘schemeId’: ‘SAML_TOKEN’,
|
||||
‘privateKey’: <PRIVATE_KEY>,
|
||||
‘samlToken’: <SAML_TOKEN>,
|
||||
‘signatureAlgorithm’: <ALGORITHM>,</div></blockquote>
|
||||
‘signatureAlgorithm’: <ALGORITHM>,</p>
|
||||
</div></blockquote>
|
||||
<p>}</p>
|
||||
<p>Security context block before signing:
|
||||
{</p>
|
||||
@ -383,8 +380,9 @@ context. A timestamp is also added to guard against replay attacks</p>
|
||||
‘signatureAlgorithm’: <ALGORITHM>,
|
||||
‘timestamp’: {</p>
|
||||
<blockquote>
|
||||
<div>‘created’: ‘2012-10-26T12:24:18.941Z’,
|
||||
‘expires’: ‘2012-10-26T12:44:18.941Z’,</div></blockquote>
|
||||
<div><p>‘created’: ‘2012-10-26T12:24:18.941Z’,
|
||||
‘expires’: ‘2012-10-26T12:44:18.941Z’,</p>
|
||||
</div></blockquote>
|
||||
<p>}</p>
|
||||
</div></blockquote>
|
||||
<p>}</p>
|
||||
@ -395,13 +393,15 @@ context. A timestamp is also added to guard against replay attacks</p>
|
||||
‘signatureAlgorithm’: <ALGORITHM>,
|
||||
‘signature’: {</p>
|
||||
<blockquote>
|
||||
<div>‘samlToken’: <SAML_TOKEN>,
|
||||
‘value’: <DIGEST></div></blockquote>
|
||||
<div><p>‘samlToken’: <SAML_TOKEN>,
|
||||
‘value’: <DIGEST></p>
|
||||
</div></blockquote>
|
||||
<p>}
|
||||
‘timestamp’: {</p>
|
||||
<blockquote>
|
||||
<div>‘created’: ‘2012-10-26T12:24:18.941Z’,
|
||||
‘expires’: ‘2012-10-26T12:44:18.941Z’,</div></blockquote>
|
||||
<div><p>‘created’: ‘2012-10-26T12:24:18.941Z’,
|
||||
‘expires’: ‘2012-10-26T12:44:18.941Z’,</p>
|
||||
</div></blockquote>
|
||||
<p>}</p>
|
||||
</div></blockquote>
|
||||
<p>}</p>
|
||||
@ -422,7 +422,7 @@ block.</p>
|
||||
<dd><p>Verify the input JSON message.</p>
|
||||
<p>For verification, we need 4 things:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>algorithm: extracted from security context</li>
|
||||
<li><p>algorithm: extracted from security context</p></li>
|
||||
</ol>
|
||||
<p>2. certificate: public key of the principal embedded in the
|
||||
SAML token is used
|
||||
@ -436,28 +436,29 @@ and the remaining part is canonicalized</p>
|
||||
‘signatureAlgorithm’: <ALGORITHM>,
|
||||
‘signature’: {</p>
|
||||
<blockquote>
|
||||
<div>‘samlToken’: <SAML_TOKEN>,
|
||||
‘value’: <DIGEST></div></blockquote>
|
||||
<div><p>‘samlToken’: <SAML_TOKEN>,
|
||||
‘value’: <DIGEST></p>
|
||||
</div></blockquote>
|
||||
<p>}
|
||||
‘timestamp’: {</p>
|
||||
<blockquote>
|
||||
<div>‘created’: ‘2012-10-26T12:24:18.941Z’,
|
||||
‘expires’: ‘2012-10-26T12:44:18.941Z’,</div></blockquote>
|
||||
<div><p>‘created’: ‘2012-10-26T12:24:18.941Z’,
|
||||
‘expires’: ‘2012-10-26T12:44:18.941Z’,</p>
|
||||
</div></blockquote>
|
||||
<p>}</p>
|
||||
</div></blockquote>
|
||||
<p>}</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>input_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Input JSON request message</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">JSON request message after signature verification</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>input_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Input JSON request message</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>JSON request message after signature verification</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -467,14 +468,11 @@ and the remaining part is canonicalized</p>
|
||||
<code class="descclassname">vmware.vapi.security.sso.</code><code class="descname">create_saml_bearer_security_context</code><span class="sig-paren">(</span><em>token</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.sso.create_saml_bearer_security_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a security context for SAML bearer token based
|
||||
authentication scheme</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SAML Token</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SAML Token</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
@ -482,24 +480,20 @@ authentication scheme</p>
|
||||
<code class="descclassname">vmware.vapi.security.sso.</code><code class="descname">create_saml_security_context</code><span class="sig-paren">(</span><em>token</em>, <em>private_key</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.sso.create_saml_security_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a security context for SAML token based
|
||||
authentication scheme</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>token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SAML Token</li>
|
||||
<li><strong>private_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute file path of the private key of the user</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SAML Token</p></li>
|
||||
<li><p><strong>private_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute file path of the private key of the user</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</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">Newly created security context</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Newly created security context</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -521,18 +515,17 @@ username/password credentials in the HTTP header.</p>
|
||||
header that contains base64 encoded string of username/password.</p>
|
||||
<p>If the request authorization header doesn’t have the username/password,
|
||||
this method returns None.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>request</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">werkzeug.wrappers.Request</span></code>) – Request object</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Security context object</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>request</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">werkzeug.wrappers.Request</span></code>) – Request object</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Security context object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -542,24 +535,20 @@ this method returns None.</p>
|
||||
<code class="descclassname">vmware.vapi.security.user_password.</code><code class="descname">create_user_password_security_context</code><span class="sig-paren">(</span><em>user_name</em>, <em>password</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.user_password.create_user_password_security_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a security context for Username-Password based authentication
|
||||
scheme</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>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the user</li>
|
||||
<li><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Password of the user</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the user</p></li>
|
||||
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Password of the user</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</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">Newly created security context</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Newly created security context</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -576,7 +565,7 @@ scheme</p>
|
||||
<a href="vmware.vapi.security.client.html" class="btn btn-neutral float-right" title="vmware.vapi.security.client package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="vmware.vapi.lib.html" class="btn btn-neutral" title="vmware.vapi.lib package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="vmware.vapi.lib.html" class="btn btn-neutral float-left" title="vmware.vapi.lib package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -585,7 +574,7 @@ scheme</p>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, VMware, Inc..
|
||||
© Copyright 2019, VMware, Inc.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@ -602,33 +591,16 @@ scheme</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'6.8.1',
|
||||
LANGUAGE:'en',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
297
vsphere/cloud/vmware.vapi.vsphere.html
Normal file
297
vsphere/cloud/vmware.vapi.vsphere.html
Normal file
@ -0,0 +1,297 @@
|
||||
|
||||
|
||||
<!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>vmware.vapi.vsphere package — vSphere Automation SDK for Python. 6.8.7 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" />
|
||||
<link rel="prev" title="vmware.vapi.security.client package" href="vmware.vapi.security.client.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"> vSphere Automation SDK for Python.
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
</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 class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="com.html">com package</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="vmware.html">vmware package</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="vmware.html#subpackages">Subpackages</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="vmware.vapi.html">vmware.vapi package</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="vmware.vapi.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.html#module-vmware.vapi.core">vmware.vapi.core module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.html#module-vmware.vapi.exception">vmware.vapi.exception module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.html#module-vmware.vapi.message">vmware.vapi.message module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">vSphere Automation SDK for Python.</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><a href="vmware.html">vmware package</a> »</li>
|
||||
|
||||
<li><a href="vmware.vapi.html">vmware.vapi package</a> »</li>
|
||||
|
||||
<li>vmware.vapi.vsphere package</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/vmware.vapi.vsphere.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="module-vmware.vapi.vsphere">
|
||||
<span id="vmware-vapi-vsphere-package"></span><h1>vmware.vapi.vsphere package<a class="headerlink" href="#module-vmware.vapi.vsphere" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-vmware.vapi.vsphere.client">
|
||||
<span id="vmware-vapi-vsphere-client-module"></span><h2>vmware.vapi.vsphere.client module<a class="headerlink" href="#module-vmware.vapi.vsphere.client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>vSphere Client</p>
|
||||
<dl class="class">
|
||||
<dt id="vmware.vapi.vsphere.client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">vmware.vapi.vsphere.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="#vmware.vapi.vsphere.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></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="vmware.vapi.vsphere.client.VsphereClient">
|
||||
<em class="property">class </em><code class="descclassname">vmware.vapi.vsphere.client.</code><code class="descname">VsphereClient</code><span class="sig-paren">(</span><em>session</em>, <em>server</em>, <em>username</em>, <em>password</em>, <em>bearer_token</em>, <em>hok_token</em>, <em>private_key</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vsphere.client.VsphereClient" 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>vSphere Client class that provides access to stubs for all services in the
|
||||
vSphere API</p>
|
||||
<p>Initialize VsphereClient by creating a parent stub factory instance
|
||||
of all vSphere components.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Requests HTTP session instance. If not specified,</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>then one is automatically created and used
|
||||
:type server: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
|
||||
:param server: vCenter host name or IP address
|
||||
:type username: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
|
||||
:param username: Name of the user
|
||||
:type password: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
|
||||
:param password: Password of the user
|
||||
:type bearer_token: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
|
||||
:param bearer_token: SAML Bearer Token
|
||||
:type hok_token: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
|
||||
:param hok_token: SAML Hok Token
|
||||
:type private_key: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
|
||||
:param private_key: Absolute file path of the private key of the user</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="vmware.vapi.vsphere.client.create_vsphere_client">
|
||||
<code class="descclassname">vmware.vapi.vsphere.client.</code><code class="descname">create_vsphere_client</code><span class="sig-paren">(</span><em>server</em>, <em>username=None</em>, <em>password=None</em>, <em>bearer_token=None</em>, <em>hok_token=None</em>, <em>private_key=None</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vsphere.client.create_vsphere_client" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Helper method to create an instance of the vSphere API client.
|
||||
Please provide one of the following options to authenticate:</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><p>username and password,</p></li>
|
||||
<li><p>bearer_token,</p></li>
|
||||
<li><p>hok_token and private_key</p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>server</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – vCenter host name or IP address</p></li>
|
||||
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the user</p></li>
|
||||
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Password of the user</p></li>
|
||||
<li><p><strong>bearer_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SAML Bearer Token</p></li>
|
||||
<li><p><strong>hok_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SAML Hok Token</p></li>
|
||||
<li><p><strong>private_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute file path of the private key of the user</p></li>
|
||||
<li><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Requests HTTP session instance. If not specified, then one
|
||||
is automatically created and used</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.vmc.client.VsphereClient</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Vsphere Client instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
|
||||
<a href="vmware.vapi.security.client.html" class="btn btn-neutral float-left" title="vmware.vapi.security.client package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<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>
|
||||
Loading…
Reference in New Issue
Block a user