1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 01:39:58 -05:00

Merge pull request #205 from kunal-pmj/gh-pages

API Documentation for VMC M9 release
This commit is contained in:
Kunal Singh 2020-01-27 18:05:54 +05:30 committed by GitHub
commit f3da93aa98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
270 changed files with 111570 additions and 1585 deletions

View File

@ -0,0 +1,14 @@
com package
===========
.. automodule:: com
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware

View File

@ -0,0 +1,35 @@
com.vmware.appliance.networking package
=======================================
.. automodule:: com.vmware.appliance.networking
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.appliance.networking.dns\_client module
--------------------------------------------------
.. automodule:: com.vmware.appliance.networking.dns_client
:members:
: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
---------------------------------------------------------
.. automodule:: com.vmware.appliance.networking.interfaces_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,27 @@
com.vmware.appliance.recovery.backup package
============================================
.. automodule:: com.vmware.appliance.recovery.backup
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.appliance.recovery.backup.job\_client module
-------------------------------------------------------
.. automodule:: com.vmware.appliance.recovery.backup.job_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.recovery.backup.system\_name\_client module
----------------------------------------------------------------
.. automodule:: com.vmware.appliance.recovery.backup.system_name_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,42 @@
com.vmware.appliance.recovery package
=====================================
.. automodule:: com.vmware.appliance.recovery
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.appliance.recovery.backup
Submodules
----------
com.vmware.appliance.recovery.backup\_client module
---------------------------------------------------
.. automodule:: com.vmware.appliance.recovery.backup_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.recovery.reconciliation\_client module
-----------------------------------------------------------
.. automodule:: com.vmware.appliance.recovery.reconciliation_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.recovery.restore\_client module
----------------------------------------------------
.. automodule:: com.vmware.appliance.recovery.restore_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,132 @@
com.vmware.appliance package
============================
.. automodule:: com.vmware.appliance
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.appliance.networking
com.vmware.appliance.recovery
com.vmware.appliance.system
Submodules
----------
com.vmware.appliance.access\_client module
------------------------------------------
.. automodule:: com.vmware.appliance.access_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.health\_client module
------------------------------------------
.. automodule:: com.vmware.appliance.health_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.local\_accounts\_client module
---------------------------------------------------
.. automodule:: com.vmware.appliance.local_accounts_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.localaccounts\_client module
-------------------------------------------------
.. automodule:: com.vmware.appliance.localaccounts_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.logging\_client module
-------------------------------------------
.. automodule:: com.vmware.appliance.logging_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.monitoring\_client module
----------------------------------------------
.. automodule:: com.vmware.appliance.monitoring_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.networking\_client module
----------------------------------------------
.. automodule:: com.vmware.appliance.networking_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.ntp\_client module
---------------------------------------
.. automodule:: com.vmware.appliance.ntp_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.recovery\_client module
--------------------------------------------
.. automodule:: com.vmware.appliance.recovery_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.shutdown\_client module
--------------------------------------------
.. automodule:: com.vmware.appliance.shutdown_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.system\_client module
------------------------------------------
.. automodule:: com.vmware.appliance.system_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.tymesync\_client module
--------------------------------------------
.. automodule:: com.vmware.appliance.tymesync_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.update\_client module
------------------------------------------
.. automodule:: com.vmware.appliance.update_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.appliance.vmon\_client module
----------------------------------------
.. automodule:: com.vmware.appliance.vmon_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
com.vmware.appliance.system package
===================================
.. automodule:: com.vmware.appliance.system
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.appliance.system.time\_client module
-----------------------------------------------
.. automodule:: com.vmware.appliance.system.time_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,27 @@
com.vmware.cis package
======================
.. automodule:: com.vmware.cis
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.cis.tagging\_client module
-------------------------------------
.. automodule:: com.vmware.cis.tagging_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.cis.task\_client module
----------------------------------
.. automodule:: com.vmware.cis.task_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,27 @@
com.vmware.content.library.item package
=======================================
.. automodule:: com.vmware.content.library.item
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.content.library.item.downloadsession\_client module
--------------------------------------------------------------
.. automodule:: com.vmware.content.library.item.downloadsession_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.content.library.item.updatesession\_client module
------------------------------------------------------------
.. automodule:: com.vmware.content.library.item.updatesession_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,26 @@
com.vmware.content.library package
==================================
.. automodule:: com.vmware.content.library
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.content.library.item
Submodules
----------
com.vmware.content.library.item\_client module
----------------------------------------------
.. automodule:: com.vmware.content.library.item_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,27 @@
com.vmware.content package
==========================
.. automodule:: com.vmware.content
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.content.library
com.vmware.content.type
Submodules
----------
com.vmware.content.library\_client module
-----------------------------------------
.. automodule:: com.vmware.content.library_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
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:

View File

@ -0,0 +1,26 @@
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:

View File

@ -0,0 +1,62 @@
com.vmware package
==================
.. automodule:: com.vmware
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.appliance
com.vmware.cis
com.vmware.content
com.vmware.vapi
com.vmware.vcenter
Submodules
----------
com.vmware.appliance\_client module
-----------------------------------
.. automodule:: com.vmware.appliance_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.cis\_client module
-----------------------------
.. automodule:: com.vmware.cis_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.content\_client module
---------------------------------
.. automodule:: com.vmware.content_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vapi\_client module
------------------------------
.. automodule:: com.vmware.vapi_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter\_client module
---------------------------------
.. automodule:: com.vmware.vcenter_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
com.vmware.vapi.metadata.authentication package
===============================================
.. automodule:: com.vmware.vapi.metadata.authentication
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.vapi.metadata.authentication.service\_client module
--------------------------------------------------------------
.. automodule:: com.vmware.vapi.metadata.authentication.service_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,27 @@
com.vmware.vapi.metadata.metamodel package
==========================================
.. automodule:: com.vmware.vapi.metadata.metamodel
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.vapi.metadata.metamodel.resource\_client module
----------------------------------------------------------
.. automodule:: com.vmware.vapi.metadata.metamodel.resource_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vapi.metadata.metamodel.service\_client module
---------------------------------------------------------
.. automodule:: com.vmware.vapi.metadata.metamodel.service_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
com.vmware.vapi.metadata.privilege package
==========================================
.. automodule:: com.vmware.vapi.metadata.privilege
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.vapi.metadata.privilege.service\_client module
---------------------------------------------------------
.. automodule:: com.vmware.vapi.metadata.privilege.service_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,52 @@
com.vmware.vapi.metadata package
================================
.. automodule:: com.vmware.vapi.metadata
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.vapi.metadata.authentication
com.vmware.vapi.metadata.metamodel
com.vmware.vapi.metadata.privilege
Submodules
----------
com.vmware.vapi.metadata.authentication\_client module
------------------------------------------------------
.. automodule:: com.vmware.vapi.metadata.authentication_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vapi.metadata.cli\_client module
-------------------------------------------
.. automodule:: com.vmware.vapi.metadata.cli_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vapi.metadata.metamodel\_client module
-------------------------------------------------
.. automodule:: com.vmware.vapi.metadata.metamodel_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vapi.metadata.privilege\_client module
-------------------------------------------------
.. automodule:: com.vmware.vapi.metadata.privilege_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,35 @@
com.vmware.vapi package
=======================
.. automodule:: com.vmware.vapi
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.vapi.metadata
com.vmware.vapi.std
Submodules
----------
com.vmware.vapi.metadata\_client module
---------------------------------------
.. automodule:: com.vmware.vapi.metadata_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vapi.std\_client module
----------------------------------
.. automodule:: com.vmware.vapi.std_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,27 @@
com.vmware.vapi.std package
===========================
.. automodule:: com.vmware.vapi.std
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.vapi.std.errors\_client module
-----------------------------------------
.. automodule:: com.vmware.vapi.std.errors_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vapi.std.interposition\_client module
------------------------------------------------
.. automodule:: com.vmware.vapi.std.interposition_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
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:

View File

@ -0,0 +1,51 @@
com.vmware.vcenter.compute.policies.capabilities package
========================================================
.. automodule:: com.vmware.vcenter.compute.policies.capabilities
:members:
:undoc-members:
:show-inheritance:
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
----------------------------------------------------------------------------------
.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client
:members:
: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:

View File

@ -0,0 +1,26 @@
com.vmware.vcenter.compute.policies package
===========================================
.. automodule:: com.vmware.vcenter.compute.policies
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.vcenter.compute.policies.capabilities
Submodules
----------
com.vmware.vcenter.compute.policies.capabilities\_client module
---------------------------------------------------------------
.. automodule:: com.vmware.vcenter.compute.policies.capabilities_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,26 @@
com.vmware.vcenter.compute package
==================================
.. automodule:: com.vmware.vcenter.compute
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.vcenter.compute.policies
Submodules
----------
com.vmware.vcenter.compute.policies\_client module
--------------------------------------------------
.. automodule:: com.vmware.vcenter.compute.policies_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
com.vmware.vcenter.deployment.install.initial\_config package
=============================================================
.. automodule:: com.vmware.vcenter.deployment.install.initial_config
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.vcenter.deployment.install.initial\_config.remote\_psc\_client module
--------------------------------------------------------------------------------
.. automodule:: com.vmware.vcenter.deployment.install.initial_config.remote_psc_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,26 @@
com.vmware.vcenter.deployment.install package
=============================================
.. automodule:: com.vmware.vcenter.deployment.install
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.vcenter.deployment.install.initial_config
Submodules
----------
com.vmware.vcenter.deployment.install.psc\_client module
--------------------------------------------------------
.. automodule:: com.vmware.vcenter.deployment.install.psc_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,26 @@
com.vmware.vcenter.deployment package
=====================================
.. automodule:: com.vmware.vcenter.deployment
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.vcenter.deployment.install
Submodules
----------
com.vmware.vcenter.deployment.install\_client module
----------------------------------------------------
.. automodule:: com.vmware.vcenter.deployment.install_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
com.vmware.vcenter.hvc.links package
====================================
.. automodule:: com.vmware.vcenter.hvc.links
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.vcenter.hvc.links.sync\_client module
------------------------------------------------
.. automodule:: com.vmware.vcenter.hvc.links.sync_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,34 @@
com.vmware.vcenter.hvc package
==============================
.. automodule:: com.vmware.vcenter.hvc
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.vcenter.hvc.links
Submodules
----------
com.vmware.vcenter.hvc.links\_client module
-------------------------------------------
.. automodule:: com.vmware.vcenter.hvc.links_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.hvc.management\_client module
------------------------------------------------
.. automodule:: com.vmware.vcenter.hvc.management_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,170 @@
com.vmware.vcenter package
==========================
.. automodule:: com.vmware.vcenter
:members:
:undoc-members:
:show-inheritance:
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
-----------------------------------------
.. automodule:: com.vmware.vcenter.compute_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.datastore\_client module
-------------------------------------------
.. automodule:: com.vmware.vcenter.datastore_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.deployment\_client module
--------------------------------------------
.. automodule:: com.vmware.vcenter.deployment_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.guest\_client module
---------------------------------------
.. automodule:: com.vmware.vcenter.guest_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.hvc\_client module
-------------------------------------
.. automodule:: com.vmware.vcenter.hvc_client
:members:
: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
-------------------------------------------
.. automodule:: com.vmware.vcenter.inventory_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.iso\_client module
-------------------------------------
.. automodule:: com.vmware.vcenter.iso_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.ovf\_client module
-------------------------------------
.. automodule:: com.vmware.vcenter.ovf_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.services\_client module
------------------------------------------
.. automodule:: com.vmware.vcenter.services_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.storage\_client module
-----------------------------------------
.. automodule:: com.vmware.vcenter.storage_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.system\_config\_client module
------------------------------------------------
.. automodule:: com.vmware.vcenter.system_config_client
:members:
: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
------------------------------------
.. automodule:: com.vmware.vcenter.vm_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.vm\_template\_client module
----------------------------------------------
.. automodule:: com.vmware.vcenter.vm_template_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
com.vmware.vcenter.storage.policies package
===========================================
.. automodule:: com.vmware.vcenter.storage.policies
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.vcenter.storage.policies.compliance\_client module
-------------------------------------------------------------
.. automodule:: com.vmware.vcenter.storage.policies.compliance_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,26 @@
com.vmware.vcenter.storage package
==================================
.. automodule:: com.vmware.vcenter.storage
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.vcenter.storage.policies
Submodules
----------
com.vmware.vcenter.storage.policies\_client module
--------------------------------------------------
.. automodule:: com.vmware.vcenter.storage.policies_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
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:

View File

@ -0,0 +1,14 @@
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

View File

@ -0,0 +1,19 @@
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:

View File

@ -0,0 +1,27 @@
com.vmware.vcenter.vm.hardware package
======================================
.. automodule:: com.vmware.vcenter.vm.hardware
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.vcenter.vm.hardware.adapter\_client module
-----------------------------------------------------
.. automodule:: com.vmware.vcenter.vm.hardware.adapter_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.vm.hardware.boot\_client module
--------------------------------------------------
.. automodule:: com.vmware.vcenter.vm.hardware.boot_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,51 @@
com.vmware.vcenter.vm package
=============================
.. automodule:: com.vmware.vcenter.vm
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
com.vmware.vcenter.vm.hardware
com.vmware.vcenter.vm.storage
Submodules
----------
com.vmware.vcenter.vm.compute\_client module
--------------------------------------------
.. automodule:: com.vmware.vcenter.vm.compute_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.vm.guest\_client module
------------------------------------------
.. automodule:: com.vmware.vcenter.vm.guest_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.vm.hardware\_client module
---------------------------------------------
.. automodule:: com.vmware.vcenter.vm.hardware_client
:members:
:undoc-members:
:show-inheritance:
com.vmware.vcenter.vm.storage\_client module
--------------------------------------------
.. automodule:: com.vmware.vcenter.vm.storage_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
com.vmware.vcenter.vm.storage package
=====================================
.. automodule:: com.vmware.vcenter.vm.storage
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.vcenter.vm.storage.policy\_client module
---------------------------------------------------
.. automodule:: com.vmware.vcenter.vm.storage.policy_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
com.vmware.vcenter.vm\_template package
=======================================
.. automodule:: com.vmware.vcenter.vm_template
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
com.vmware.vcenter.vm\_template.library\_items\_client module
-------------------------------------------------------------
.. automodule:: com.vmware.vcenter.vm_template.library_items_client
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,82 @@
.. _enumeration_description:
Interface definition language to python mapping for enumerated types
--------------------------------------------------------------------
The interface language definition type system includes enumerated types. Python
SDK supports both 2.x and 3.x versions of Python. Since Python 2.x does
not have first class support for enumerations, special classes are
generated to represent enumerated types from the interface definition
language. The special class contains class attributes which represent
the values of the enumerated type.
This documentation explains the following:
* How the class variables are defined in the module. This specifies the names that you can use in your program.
* How you instantiate a class to use it for communication with future versions of the service.
Example of an enumerated type documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
*class* com.vmware.vapi.metadata_client. **SourceType** (string)
Bases: vmware.vapi.bindings.enum.Enum
Metadata source type
.. note::
This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See :ref:`enumerated type description page <enumeration_description>`.
**Parameters** : **string** (``str``) String value for the SourceType instance.
**FILE** = *SourceType(string='FILE')*
If the source is backed by a file.
**REMOTE** = *SourceType(string='REMOTE')*
If the source is backed by a remote service.
Code Examples
^^^^^^^^^^^^^
The enumerated type classes are defined in python modules that your code
imports. You can use these in your code.
1. If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class.
.. code-block:: python
# SourceType is an enumerated type
from com.vmware.vapi.metadata_client import SourceType
# SourceType has two class attrites, SourceType.FILE and SourceType.REMOTE
spec = Source.CreateSpec(type=SourceType.FILE, filepath='entity_metadata.json', description='Entity service')
source_svc.create(id='entity', spec=spec)
2. When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values.
.. code-block:: python
# SourceType is an enumerated type
from com.vmware.vapi.metadata_client import SourceType
source_info = source_svc.get(id='entity')
if (source_info.type == SourceType.FILE) {
print 'Source is a file'
} else if (source_info.type == SourceType.REMOTE) {
print 'Source is a remote provider'
} else {
print 'Unknown source type: %s' % str(source_info.type)
}
3. Sending a new enumerated type value to a server that has a newer version of the enumerated type.
To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate the
enumerated type class.
.. code-block:: python
# If a newer version of SourceType has a new value FOLDER, FOLDER would be one
# of the class attributes for SourceType. In the older version, SourceType has
# only two class attributes, FILE and REMOTE
from com.vmware.vapi.metadata_client import SourceType
spec = Source.CreateSpec(type=SourceType('FOLDER'), filepath='entity_metadata', description='Entity service')
source_svc.create(id='entity', spec=spec)

View File

@ -0,0 +1,22 @@
.. vSphere Automation SDK for Python. documentation master file, created by
sphinx-quickstart on Tue Aug 27 13:22:23 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!
==============================================================
.. toctree::
:maxdepth: 10
:caption: Contents:
com
vmware
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -0,0 +1,14 @@
vmware package
==============
.. automodule:: vmware
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
vmware.vapi

View File

@ -0,0 +1,19 @@
vmware.vapi.lib package
=======================
.. automodule:: vmware.vapi.lib
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
vmware.vapi.lib.connect module
------------------------------
.. automodule:: vmware.vapi.lib.connect
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,44 @@
vmware.vapi package
===================
.. automodule:: vmware.vapi
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
vmware.vapi.lib
vmware.vapi.security
vmware.vapi.vsphere
Submodules
----------
vmware.vapi.core module
-----------------------
.. automodule:: vmware.vapi.core
:members:
:undoc-members:
:show-inheritance:
vmware.vapi.exception module
----------------------------
.. automodule:: vmware.vapi.exception
:members:
:undoc-members:
:show-inheritance:
vmware.vapi.message module
--------------------------
.. automodule:: vmware.vapi.message
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
vmware.vapi.security.client package
===================================
.. automodule:: vmware.vapi.security.client
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
vmware.vapi.security.client.security\_context\_filter module
------------------------------------------------------------
.. automodule:: vmware.vapi.security.client.security_context_filter
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,42 @@
vmware.vapi.security package
============================
.. automodule:: vmware.vapi.security
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
vmware.vapi.security.client
Submodules
----------
vmware.vapi.security.session module
-----------------------------------
.. automodule:: vmware.vapi.security.session
:members:
:undoc-members:
:show-inheritance:
vmware.vapi.security.sso module
-------------------------------
.. automodule:: vmware.vapi.security.sso
:members:
:undoc-members:
:show-inheritance:
vmware.vapi.security.user\_password module
------------------------------------------
.. automodule:: vmware.vapi.security.user_password
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
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:

View File

@ -0,0 +1,764 @@
/*
* basic.css
* ~~~~~~~~~
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
word-wrap: break-word;
overflow-wrap : break-word;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar #searchbox form.search {
overflow: hidden;
}
div.sphinxsidebar #searchbox input[type="text"] {
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
}
div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}
img {
border: 0;
max-width: 100%;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
margin-left: auto;
margin-right: auto;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable ul {
margin-top: 0;
margin-bottom: 0;
list-style-type: none;
}
table.indextable > tbody > tr > td > ul {
padding-left: 0em;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
/* -- domain module index --------------------------------------------------- */
table.modindextable td {
padding: 2px;
border-collapse: collapse;
}
/* -- general body styles --------------------------------------------------- */
div.body {
min-width: 450px;
max-width: 800px;
}
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
-webkit-hyphens: auto;
hyphens: auto;
}
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,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink,
caption:hover > a.headerlink,
p.caption:hover > a.headerlink,
div.code-block-caption:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.first {
margin-top: 0 !important;
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
img.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
}
img.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
}
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
img.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left;
}
.align-center {
text-align: center;
}
.align-default {
text-align: center;
}
.align-right {
text-align: right;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px 7px 0 7px;
background-color: #ffe;
width: 40%;
float: right;
}
p.sidebar-title {
font-weight: bold;
}
/* -- topics ---------------------------------------------------------------- */
div.topic {
border: 1px solid #ccc;
padding: 7px 7px 0 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
div.admonition dl {
margin-bottom: 0;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- tables ---------------------------------------------------------------- */
table.docutils {
border: 0;
border-collapse: collapse;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
table.align-default {
margin-left: auto;
margin-right: auto;
}
table caption span.caption-number {
font-style: italic;
}
table caption span.caption-text {
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
th {
text-align: left;
padding-right: 5px;
}
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
}
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 {
margin: 0.5em;
padding: 0.5em;
}
div.figure p.caption {
padding: 0.3em;
}
div.figure p.caption span.caption-number {
font-style: italic;
}
div.figure p.caption span.caption-text {
}
/* -- field list styles ----------------------------------------------------- */
table.field-list td, table.field-list th {
border: 0 !important;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
/* -- hlist styles ---------------------------------------------------------- */
table.hlist td {
vertical-align: top;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
}
ol.loweralpha {
list-style: lower-alpha;
}
ol.upperalpha {
list-style: upper-alpha;
}
ol.lowerroman {
list-style: lower-roman;
}
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: grid;
grid-template-columns: fit-content(30%) auto;
}
dl.field-list > dt {
font-weight: bold;
word-break: break-word;
padding-left: 0.5em;
padding-right: 5px;
}
dl.field-list > dt:after {
content: ":";
}
dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
margin-left: 0em;
margin-bottom: 0em;
}
dl {
margin-bottom: 15px;
}
dd > p:first-child {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
dt:target, span.highlighted {
background-color: #fbe54e;
}
rect.highlighted {
fill: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.optional {
font-size: 1.3em;
}
.sig-paren {
font-size: larger;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
background-color: #ffa;
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
.guilabel, .menuselection {
font-family: sans-serif;
}
.accelerator {
text-decoration: underline;
}
.classifier {
font-style: oblique;
}
.classifier:before {
font-style: normal;
margin: 0.5em;
content: ":";
}
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
span.pre {
-moz-hyphens: none;
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
}
td.linenos pre {
padding: 5px 0px;
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
margin-left: 0.5em;
}
table.highlighttable td {
padding: 0 0.5em 0 0.5em;
}
div.code-block-caption {
padding: 2px 5px;
font-size: small;
}
div.code-block-caption code {
background-color: transparent;
}
div.code-block-caption + div > div.highlight > pre {
margin-top: 0;
}
div.code-block-caption span.caption-number {
padding: 0.1em 0.3em;
font-style: italic;
}
div.code-block-caption span.caption-text {
}
div.literal-block-wrapper {
padding: 1em 1em 0;
}
div.literal-block-wrapper div.highlight {
margin: 0;
}
code.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}
code.descclassname {
background-color: transparent;
}
code.xref, a code {
background-color: transparent;
font-weight: bold;
}
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
background-color: transparent;
}
.viewcode-link {
float: right;
}
.viewcode-back {
float: right;
font-family: sans-serif;
}
div.viewcode-block:target {
margin: -1px -10px;
padding: 0 10px;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
span.eqno a.headerlink {
position: relative;
left: 0px;
z-index: 1;
}
div.math:hover a.headerlink {
visibility: visible;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}

View File

@ -0,0 +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%;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

View File

@ -0,0 +1,314 @@
/*
* doctools.js
* ~~~~~~~~~~~
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/**
* select a different prefix for underscore
*/
$u = _.noConflict();
/**
* make the code below compatible with browsers without
* an installed firebug like debugger
if (!window.console || !console.firebug) {
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
"profile", "profileEnd"];
window.console = {};
for (var i = 0; i < names.length; ++i)
window.console[names[i]] = function() {};
}
*/
/**
* small helper function to urldecode strings
*/
jQuery.urldecode = function(x) {
return decodeURIComponent(x).replace(/\+/g, ' ');
};
/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;
/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};
/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
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);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};
/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];
return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
/**
* Small JavaScript module for the documentation.
*/
var Documentation = {
init : function() {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
this.initOnKeyListeners();
}
},
/**
* i18n support
*/
TRANSLATIONS : {},
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
if (typeof translated === 'undefined')
return string;
return (typeof translated === 'string') ? translated : translated[0];
},
ngettext : function(singular, plural, n) {
var translated = Documentation.TRANSLATIONS[singular];
if (typeof translated === 'undefined')
return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
},
addTranslations : function(catalog) {
for (var key in catalog.messages)
this.TRANSLATIONS[key] = catalog.messages[key];
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
this.LOCALE = catalog.locale;
},
/**
* add context elements like header anchor links
*/
addContextElements : function() {
$('div[id] > :header:first').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this headline')).
appendTo(this);
});
$('dt[id]').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this definition')).
appendTo(this);
});
},
/**
* workaround a firefox stupidity
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
},
/**
* highlight the search words provided in the url in the text
*/
highlightSearchWords : function() {
var params = $.getQueryParameters();
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
if (terms.length) {
var body = $('div.body');
if (!body.length) {
body = $('body');
}
window.setTimeout(function() {
$.each(terms, function() {
body.highlightText(this.toLowerCase(), 'highlighted');
});
}, 10);
$('<p class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
.appendTo($('#searchbox'));
}
},
/**
* init the domain index toggle buttons
*/
initIndexTable : function() {
var togglers = $('img.toggler').click(function() {
var src = $(this).attr('src');
var idnum = $(this).attr('id').substr(7);
$('tr.cg-' + idnum).toggle();
if (src.substr(-9) === 'minus.png')
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
else
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
}).css('display', '');
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
togglers.click();
}
},
/**
* helper function to hide the search marks again
*/
hideSearchWords : function() {
$('#searchbox .highlight-link').fadeOut(300);
$('span.highlighted').removeClass('highlighted');
},
/**
* make the url absolute
*/
makeURL : function(relativeURL) {
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
},
/**
* get the current relative url
*/
getCurrentURL : function() {
var path = document.location.pathname;
var parts = path.split(/\//);
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
if (this === '..')
parts.pop();
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
},
initOnKeyListeners: function() {
$(document).keyup(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box or textarea
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');
if (prevHref) {
window.location.href = prevHref;
return false;
}
case 39: // right
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
}
}
});
}
};
// quick alias for translations
_ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
});

View File

@ -0,0 +1,10 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '6.9.1',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false
};

Binary file not shown.

After

Width:  |  Height:  |  Size: 286 B

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Some files were not shown because too many files have changed in this diff Show More