mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 01:39:58 -05:00
Merge pull request #179 from kunal-pmj/gh-pages
Documentation change for M8 release
This commit is contained in:
Tianhao He
GitHub
commit
623ba107ce
@ -2,14 +2,13 @@ com package
|
||||
===========
|
||||
|
||||
.. automodule:: com
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware
|
||||
|
||||
com.vmware
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.appliance.networking package
|
||||
=======================================
|
||||
|
||||
.. automodule:: com.vmware.appliance.networking
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,24 +13,23 @@ com.vmware.appliance.networking.dns\_client module
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.networking.dns_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.networking.firewall\_client module
|
||||
-------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.networking.firewall_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.networking.interfaces\_client module
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.networking.interfaces_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.appliance.recovery.backup package
|
||||
============================================
|
||||
|
||||
.. automodule:: com.vmware.appliance.recovery.backup
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,16 +13,15 @@ com.vmware.appliance.recovery.backup.job\_client module
|
||||
-------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.recovery.backup.job_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
: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:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware.appliance.recovery package
|
||||
=====================================
|
||||
|
||||
.. automodule:: com.vmware.appliance.recovery
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.appliance.recovery.backup
|
||||
com.vmware.appliance.recovery.backup
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,24 +20,23 @@ com.vmware.appliance.recovery.backup\_client module
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.recovery.backup_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.recovery.reconciliation\_client module
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.recovery.reconciliation_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.recovery.restore\_client module
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.recovery.restore_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,18 +2,18 @@ com.vmware.appliance package
|
||||
============================
|
||||
|
||||
.. automodule:: com.vmware.appliance
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.appliance.networking
|
||||
com.vmware.appliance.recovery
|
||||
com.vmware.appliance.system
|
||||
com.vmware.appliance.networking
|
||||
com.vmware.appliance.recovery
|
||||
com.vmware.appliance.system
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -22,112 +22,111 @@ com.vmware.appliance.access\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.access_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.health\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.health_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.local\_accounts\_client module
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.local_accounts_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.localaccounts\_client module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.localaccounts_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.logging\_client module
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.logging_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.monitoring\_client module
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.monitoring_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.networking\_client module
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.networking_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.ntp\_client module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.ntp_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.recovery\_client module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.recovery_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.shutdown\_client module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.shutdown_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.system\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.system_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.tymesync\_client module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.tymesync_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.update\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.update_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.appliance.vmon\_client module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.vmon_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.appliance.system package
|
||||
===================================
|
||||
|
||||
.. automodule:: com.vmware.appliance.system
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.appliance.system.time\_client module
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance.system.time_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.cis package
|
||||
======================
|
||||
|
||||
.. automodule:: com.vmware.cis
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,16 +13,15 @@ com.vmware.cis.tagging\_client module
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.cis.tagging_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.cis.task\_client module
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: com.vmware.cis.task_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.content.library.item package
|
||||
=======================================
|
||||
|
||||
.. automodule:: com.vmware.content.library.item
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,16 +13,15 @@ com.vmware.content.library.item.downloadsession\_client module
|
||||
--------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.content.library.item.downloadsession_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
: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:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware.content.library package
|
||||
==================================
|
||||
|
||||
.. automodule:: com.vmware.content.library
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.content.library.item
|
||||
com.vmware.content.library.item
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,8 +20,7 @@ com.vmware.content.library.item\_client module
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.content.library.item_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,17 +2,17 @@ com.vmware.content package
|
||||
==========================
|
||||
|
||||
.. automodule:: com.vmware.content
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.content.library
|
||||
com.vmware.content.type
|
||||
com.vmware.content.library
|
||||
com.vmware.content.type
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -21,8 +21,7 @@ com.vmware.content.library\_client module
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.content.library_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.content.type.ovf package
|
||||
===================================
|
||||
|
||||
.. automodule:: com.vmware.content.type.ovf
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.content.type.ovf.policy\_client module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.content.type.ovf.policy_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware.content.type package
|
||||
===============================
|
||||
|
||||
.. automodule:: com.vmware.content.type
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.content.type.ovf
|
||||
com.vmware.content.type.ovf
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,8 +20,7 @@ com.vmware.content.type.ovf\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.content.type.ovf_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,20 +2,20 @@ com.vmware package
|
||||
==================
|
||||
|
||||
.. automodule:: com.vmware
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.appliance
|
||||
com.vmware.cis
|
||||
com.vmware.content
|
||||
com.vmware.vapi
|
||||
com.vmware.vcenter
|
||||
com.vmware.appliance
|
||||
com.vmware.cis
|
||||
com.vmware.content
|
||||
com.vmware.vapi
|
||||
com.vmware.vcenter
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -24,40 +24,39 @@ com.vmware.appliance\_client module
|
||||
-----------------------------------
|
||||
|
||||
.. automodule:: com.vmware.appliance_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.cis\_client module
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: com.vmware.cis_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.content\_client module
|
||||
---------------------------------
|
||||
|
||||
.. automodule:: com.vmware.content_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vapi\_client module
|
||||
------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter\_client module
|
||||
---------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vapi.metadata.authentication package
|
||||
===============================================
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata.authentication
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.vapi.metadata.authentication.service\_client module
|
||||
--------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata.authentication.service_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vapi.metadata.metamodel package
|
||||
==========================================
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata.metamodel
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,16 +13,15 @@ com.vmware.vapi.metadata.metamodel.resource\_client module
|
||||
----------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata.metamodel.resource_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
: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:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vapi.metadata.privilege package
|
||||
==========================================
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata.privilege
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.vapi.metadata.privilege.service\_client module
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata.privilege.service_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,18 +2,18 @@ com.vmware.vapi.metadata package
|
||||
================================
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vapi.metadata.authentication
|
||||
com.vmware.vapi.metadata.metamodel
|
||||
com.vmware.vapi.metadata.privilege
|
||||
com.vmware.vapi.metadata.authentication
|
||||
com.vmware.vapi.metadata.metamodel
|
||||
com.vmware.vapi.metadata.privilege
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -22,32 +22,31 @@ com.vmware.vapi.metadata.authentication\_client module
|
||||
------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata.authentication_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vapi.metadata.cli\_client module
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata.cli_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vapi.metadata.metamodel\_client module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata.metamodel_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vapi.metadata.privilege\_client module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata.privilege_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,17 +2,17 @@ com.vmware.vapi package
|
||||
=======================
|
||||
|
||||
.. automodule:: com.vmware.vapi
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vapi.metadata
|
||||
com.vmware.vapi.std
|
||||
com.vmware.vapi.metadata
|
||||
com.vmware.vapi.std
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -21,16 +21,15 @@ com.vmware.vapi.metadata\_client module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.metadata_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vapi.std\_client module
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.std_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vapi.std package
|
||||
===========================
|
||||
|
||||
.. automodule:: com.vmware.vapi.std
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,15 @@ com.vmware.vapi.std.errors\_client module
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.std.errors_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vapi.std.interposition\_client module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vapi.std.interposition_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vcenter.certificate\_management package
|
||||
==================================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.certificate_management
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.vcenter.certificate\_management.vcenter\_client module
|
||||
-----------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.certificate_management.vcenter_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vcenter.compute.policies.capabilities package
|
||||
========================================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.compute.policies.capabilities
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,40 +13,39 @@ com.vmware.vcenter.compute.policies.capabilities.disable\_drs\_vmotion\_client m
|
||||
-------------------------------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
: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:
|
||||
: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:
|
||||
: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:
|
||||
: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:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware.vcenter.compute.policies package
|
||||
===========================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.compute.policies
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vcenter.compute.policies.capabilities
|
||||
com.vmware.vcenter.compute.policies.capabilities
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,8 +20,7 @@ com.vmware.vcenter.compute.policies.capabilities\_client module
|
||||
---------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.compute.policies.capabilities_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware.vcenter.compute package
|
||||
==================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.compute
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vcenter.compute.policies
|
||||
com.vmware.vcenter.compute.policies
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,8 +20,7 @@ com.vmware.vcenter.compute.policies\_client module
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.compute.policies_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vcenter.deployment.install.initial\_config package
|
||||
=============================================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.deployment.install.initial_config
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ 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:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware.vcenter.deployment.install package
|
||||
=============================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.deployment.install
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vcenter.deployment.install.initial_config
|
||||
com.vmware.vcenter.deployment.install.initial_config
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,8 +20,7 @@ com.vmware.vcenter.deployment.install.psc\_client module
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.deployment.install.psc_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware.vcenter.deployment package
|
||||
=====================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.deployment
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vcenter.deployment.install
|
||||
com.vmware.vcenter.deployment.install
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,8 +20,7 @@ com.vmware.vcenter.deployment.install\_client module
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.deployment.install_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vcenter.hvc.links package
|
||||
====================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.hvc.links
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.vcenter.hvc.links.sync\_client module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.hvc.links.sync_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware.vcenter.hvc package
|
||||
==============================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.hvc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vcenter.hvc.links
|
||||
com.vmware.vcenter.hvc.links
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,16 +20,15 @@ com.vmware.vcenter.hvc.links\_client module
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.hvc.links_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.hvc.management\_client module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.hvc.management_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,23 +2,24 @@ com.vmware.vcenter package
|
||||
==========================
|
||||
|
||||
.. automodule:: com.vmware.vcenter
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
: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.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
|
||||
----------
|
||||
@ -27,152 +28,143 @@ com.vmware.vcenter.certificate\_management\_client module
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.certificate_management_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.compute\_client module
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.compute_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.datastore\_client module
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.datastore_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.deployment\_client module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.deployment_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.guest\_client module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.guest_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.hvc\_client module
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.hvc_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.identity\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.identity_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.inventory\_client module
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.inventory_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
: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.lcm\_client module
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.lcm_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.ovf\_client module
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.ovf_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.services\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.services_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.storage\_client module
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.storage_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.system\_config\_client module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.system_config_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.tokenservice\_client module
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.tokenservice_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.topology\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.topology_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.vcha\_client module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vcha_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.vm\_client module
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.vm\_template\_client module
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm_template_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vcenter.storage.policies package
|
||||
===========================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.storage.policies
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.vcenter.storage.policies.compliance\_client module
|
||||
-------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.storage.policies.compliance_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ com.vmware.vcenter.storage package
|
||||
==================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.storage
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vcenter.storage.policies
|
||||
com.vmware.vcenter.storage.policies
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,8 +20,7 @@ com.vmware.vcenter.storage.policies\_client module
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.storage.policies_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vcenter.system\_config.features package
|
||||
==================================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.system_config.features
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ 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:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,14 +2,13 @@ com.vmware.vcenter.system\_config package
|
||||
=========================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.system_config
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vcenter.system_config.features
|
||||
|
||||
com.vmware.vcenter.system_config.features
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vcenter.vcha package
|
||||
===============================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vcha
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.vcenter.vcha.cluster\_client module
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vcha.cluster_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vcenter.vm.hardware package
|
||||
======================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm.hardware
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,16 +13,15 @@ com.vmware.vcenter.vm.hardware.adapter\_client module
|
||||
-----------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm.hardware.adapter_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
: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:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,17 +2,17 @@ com.vmware.vcenter.vm package
|
||||
=============================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
com.vmware.vcenter.vm.hardware
|
||||
com.vmware.vcenter.vm.storage
|
||||
com.vmware.vcenter.vm.hardware
|
||||
com.vmware.vcenter.vm.storage
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -21,32 +21,31 @@ com.vmware.vcenter.vm.compute\_client module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm.compute_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.vm.guest\_client module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm.guest_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.vm.hardware\_client module
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm.hardware_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vcenter.vm.storage\_client module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm.storage_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vcenter.vm.storage package
|
||||
=====================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm.storage
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.vcenter.vm.storage.policy\_client module
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm.storage.policy_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ com.vmware.vcenter.vm\_template package
|
||||
=======================================
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm_template
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ com.vmware.vcenter.vm\_template.library\_items\_client module
|
||||
-------------------------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vcenter.vm_template.library_items_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
.. vSphere Automation SDK for Python. documentation master file, created by
|
||||
sphinx-quickstart on Mon May 27 04:22:27 2019.
|
||||
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.
|
||||
|
||||
|
||||
@ -2,14 +2,13 @@ vmware package
|
||||
==============
|
||||
|
||||
.. automodule:: vmware
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
vmware.vapi
|
||||
|
||||
vmware.vapi
|
||||
|
||||
@ -2,9 +2,9 @@ vmware.vapi.lib package
|
||||
=======================
|
||||
|
||||
.. automodule:: vmware.vapi.lib
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ vmware.vapi.lib.connect module
|
||||
------------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.lib.connect
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,18 +2,18 @@ vmware.vapi package
|
||||
===================
|
||||
|
||||
.. automodule:: vmware.vapi
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
vmware.vapi.lib
|
||||
vmware.vapi.security
|
||||
vmware.vapi.vsphere
|
||||
vmware.vapi.lib
|
||||
vmware.vapi.security
|
||||
vmware.vapi.vsphere
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -22,24 +22,23 @@ vmware.vapi.core module
|
||||
-----------------------
|
||||
|
||||
.. automodule:: vmware.vapi.core
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
vmware.vapi.exception module
|
||||
----------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.exception
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
vmware.vapi.message module
|
||||
--------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.message
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ vmware.vapi.security.client package
|
||||
===================================
|
||||
|
||||
.. automodule:: vmware.vapi.security.client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ vmware.vapi.security.client.security\_context\_filter module
|
||||
------------------------------------------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.security.client.security_context_filter
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@ vmware.vapi.security package
|
||||
============================
|
||||
|
||||
.. automodule:: vmware.vapi.security
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
vmware.vapi.security.client
|
||||
vmware.vapi.security.client
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -20,24 +20,23 @@ vmware.vapi.security.session module
|
||||
-----------------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.security.session
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
vmware.vapi.security.sso module
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.security.sso
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
vmware.vapi.security.user\_password module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.security.user_password
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -1,20 +0,0 @@
|
||||
vmware.vapi.stdlib.client package
|
||||
=================================
|
||||
|
||||
.. automodule:: vmware.vapi.stdlib.client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
vmware.vapi.stdlib.client.factories module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.stdlib.client.factories
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
vmware.vapi.stdlib package
|
||||
==========================
|
||||
|
||||
.. automodule:: vmware.vapi.stdlib
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
vmware.vapi.stdlib.client
|
||||
|
||||
@ -1,28 +0,0 @@
|
||||
vmware.vapi.vmc package
|
||||
=======================
|
||||
|
||||
.. automodule:: vmware.vapi.vmc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
vmware.vapi.vmc.client module
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.vmc.client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
vmware.vapi.vmc.csp\_filter module
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.vmc.csp_filter
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@ vmware.vapi.vsphere package
|
||||
===========================
|
||||
|
||||
.. automodule:: vmware.vapi.vsphere
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@ -13,8 +13,7 @@ vmware.vapi.vsphere.client module
|
||||
---------------------------------
|
||||
|
||||
.. automodule:: vmware.vapi.vsphere.client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 673 B |
@ -289,6 +289,12 @@ img.align-center, .figure.align-center, object.align-center {
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
img.align-default, .figure.align-default {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left;
|
||||
}
|
||||
@ -297,6 +303,10 @@ img.align-center, .figure.align-center, object.align-center {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-default {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-right {
|
||||
text-align: right;
|
||||
}
|
||||
@ -368,6 +378,11 @@ table.align-center {
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-default {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
@ -505,14 +520,15 @@ dl.citation > dd:after {
|
||||
}
|
||||
|
||||
dl.field-list {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
display: grid;
|
||||
grid-template-columns: fit-content(30%) auto;
|
||||
}
|
||||
|
||||
dl.field-list > dt {
|
||||
flex-basis: 20%;
|
||||
font-weight: bold;
|
||||
word-break: break-word;
|
||||
padding-left: 0.5em;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
dl.field-list > dt:after {
|
||||
@ -520,8 +536,8 @@ dl.field-list > dt:after {
|
||||
}
|
||||
|
||||
dl.field-list > dd {
|
||||
flex-basis: 70%;
|
||||
padding-left: 1em;
|
||||
padding-left: 0.5em;
|
||||
margin-top: 0em;
|
||||
margin-left: 0em;
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 756 B |
Binary file not shown.
|
Before Width: | Height: | Size: 829 B |
Binary file not shown.
|
Before Width: | Height: | Size: 641 B |
@ -1,6 +1,6 @@
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '6.8.7',
|
||||
VERSION: '6.9.1',
|
||||
LANGUAGE: 'en',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 222 B |
Binary file not shown.
|
Before Width: | Height: | Size: 202 B |
10598
vsphere/cloud/_static/jquery-3.4.1.js
vendored
Normal file
10598
vsphere/cloud/_static/jquery-3.4.1.js
vendored
Normal file
File diff suppressed because it is too large
Load Diff
6
vsphere/cloud/_static/jquery.js
vendored
6
vsphere/cloud/_static/jquery.js
vendored
File diff suppressed because one or more lines are too long
@ -319,12 +319,13 @@ var Search = {
|
||||
for (var prefix in objects) {
|
||||
for (var name in objects[prefix]) {
|
||||
var fullname = (prefix ? prefix + '.' : '') + name;
|
||||
if (fullname.toLowerCase().indexOf(object) > -1) {
|
||||
var fullnameLower = fullname.toLowerCase()
|
||||
if (fullnameLower.indexOf(object) > -1) {
|
||||
var score = 0;
|
||||
var parts = fullname.split('.');
|
||||
var parts = fullnameLower.split('.');
|
||||
// check for different match types: exact matches of full name or
|
||||
// "last name" (i.e. last dotted part)
|
||||
if (fullname == object || parts[parts.length - 1] == object) {
|
||||
if (fullnameLower == object || parts[parts.length - 1] == object) {
|
||||
score += Scorer.objNameMatch;
|
||||
// matches in last name
|
||||
} else if (parts[parts.length - 1].indexOf(object) > -1) {
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 214 B |
Binary file not shown.
|
Before Width: | Height: | Size: 203 B |
@ -1,808 +0,0 @@
|
||||
/*
|
||||
* websupport.js
|
||||
* ~~~~~~~~~~~~~
|
||||
*
|
||||
* sphinx.websupport utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
(function($) {
|
||||
$.fn.autogrow = function() {
|
||||
return this.each(function() {
|
||||
var textarea = this;
|
||||
|
||||
$.fn.autogrow.resize(textarea);
|
||||
|
||||
$(textarea)
|
||||
.focus(function() {
|
||||
textarea.interval = setInterval(function() {
|
||||
$.fn.autogrow.resize(textarea);
|
||||
}, 500);
|
||||
})
|
||||
.blur(function() {
|
||||
clearInterval(textarea.interval);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
$.fn.autogrow.resize = function(textarea) {
|
||||
var lineHeight = parseInt($(textarea).css('line-height'), 10);
|
||||
var lines = textarea.value.split('\n');
|
||||
var columns = textarea.cols;
|
||||
var lineCount = 0;
|
||||
$.each(lines, function() {
|
||||
lineCount += Math.ceil(this.length / columns) || 1;
|
||||
});
|
||||
var height = lineHeight * (lineCount + 1);
|
||||
$(textarea).css('height', height);
|
||||
};
|
||||
})(jQuery);
|
||||
|
||||
(function($) {
|
||||
var comp, by;
|
||||
|
||||
function init() {
|
||||
initEvents();
|
||||
initComparator();
|
||||
}
|
||||
|
||||
function initEvents() {
|
||||
$(document).on("click", 'a.comment-close', function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.vote', function(event) {
|
||||
event.preventDefault();
|
||||
handleVote($(this));
|
||||
});
|
||||
$(document).on("click", 'a.reply', function(event) {
|
||||
event.preventDefault();
|
||||
openReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.close-reply', function(event) {
|
||||
event.preventDefault();
|
||||
closeReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.sort-option', function(event) {
|
||||
event.preventDefault();
|
||||
handleReSort($(this));
|
||||
});
|
||||
$(document).on("click", 'a.show-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
showProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.hide-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.show-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
showProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.hide-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.accept-comment', function(event) {
|
||||
event.preventDefault();
|
||||
acceptComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.delete-comment', function(event) {
|
||||
event.preventDefault();
|
||||
deleteComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.comment-markup', function(event) {
|
||||
event.preventDefault();
|
||||
toggleCommentMarkupBox($(this).attr('id').substring(2));
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Set comp, which is a comparator function used for sorting and
|
||||
* inserting comments into the list.
|
||||
*/
|
||||
function setComparator() {
|
||||
// If the first three letters are "asc", sort in ascending order
|
||||
// and remove the prefix.
|
||||
if (by.substring(0,3) == 'asc') {
|
||||
var i = by.substring(3);
|
||||
comp = function(a, b) { return a[i] - b[i]; };
|
||||
} else {
|
||||
// Otherwise sort in descending order.
|
||||
comp = function(a, b) { return b[by] - a[by]; };
|
||||
}
|
||||
|
||||
// Reset link styles and format the selected sort option.
|
||||
$('a.sel').attr('href', '#').removeClass('sel');
|
||||
$('a.by' + by).removeAttr('href').addClass('sel');
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a comp function. If the user has preferences stored in
|
||||
* the sortBy cookie, use those, otherwise use the default.
|
||||
*/
|
||||
function initComparator() {
|
||||
by = 'rating'; // Default to sort by rating.
|
||||
// If the sortBy cookie is set, use that instead.
|
||||
if (document.cookie.length > 0) {
|
||||
var start = document.cookie.indexOf('sortBy=');
|
||||
if (start != -1) {
|
||||
start = start + 7;
|
||||
var end = document.cookie.indexOf(";", start);
|
||||
if (end == -1) {
|
||||
end = document.cookie.length;
|
||||
by = unescape(document.cookie.substring(start, end));
|
||||
}
|
||||
}
|
||||
}
|
||||
setComparator();
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a comment div.
|
||||
*/
|
||||
function show(id) {
|
||||
$('#ao' + id).hide();
|
||||
$('#ah' + id).show();
|
||||
var context = $.extend({id: id}, opts);
|
||||
var popup = $(renderTemplate(popupTemplate, context)).hide();
|
||||
popup.find('textarea[name="proposal"]').hide();
|
||||
popup.find('a.by' + by).addClass('sel');
|
||||
var form = popup.find('#cf' + id);
|
||||
form.submit(function(event) {
|
||||
event.preventDefault();
|
||||
addComment(form);
|
||||
});
|
||||
$('#s' + id).after(popup);
|
||||
popup.slideDown('fast', function() {
|
||||
getComments(id);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Hide a comment div.
|
||||
*/
|
||||
function hide(id) {
|
||||
$('#ah' + id).hide();
|
||||
$('#ao' + id).show();
|
||||
var div = $('#sc' + id);
|
||||
div.slideUp('fast', function() {
|
||||
div.remove();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Perform an ajax request to get comments for a node
|
||||
* and insert the comments into the comments tree.
|
||||
*/
|
||||
function getComments(id) {
|
||||
$.ajax({
|
||||
type: 'GET',
|
||||
url: opts.getCommentsURL,
|
||||
data: {node: id},
|
||||
success: function(data, textStatus, request) {
|
||||
var ul = $('#cl' + id);
|
||||
var speed = 100;
|
||||
$('#cf' + id)
|
||||
.find('textarea[name="proposal"]')
|
||||
.data('source', data.source);
|
||||
|
||||
if (data.comments.length === 0) {
|
||||
ul.html('<li>No comments yet.</li>');
|
||||
ul.data('empty', true);
|
||||
} else {
|
||||
// If there are comments, sort them and put them in the list.
|
||||
var comments = sortComments(data.comments);
|
||||
speed = data.comments.length * 100;
|
||||
appendComments(comments, ul);
|
||||
ul.data('empty', false);
|
||||
}
|
||||
$('#cn' + id).slideUp(speed + 200);
|
||||
ul.slideDown(speed);
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem retrieving the comments.');
|
||||
},
|
||||
dataType: 'json'
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a comment via ajax and insert the comment into the comment tree.
|
||||
*/
|
||||
function addComment(form) {
|
||||
var node_id = form.find('input[name="node"]').val();
|
||||
var parent_id = form.find('input[name="parent"]').val();
|
||||
var text = form.find('textarea[name="comment"]').val();
|
||||
var proposal = form.find('textarea[name="proposal"]').val();
|
||||
|
||||
if (text == '') {
|
||||
showError('Please enter a comment.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Disable the form that is being submitted.
|
||||
form.find('textarea,input').attr('disabled', 'disabled');
|
||||
|
||||
// Send the comment to the server.
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: opts.addCommentURL,
|
||||
dataType: 'json',
|
||||
data: {
|
||||
node: node_id,
|
||||
parent: parent_id,
|
||||
text: text,
|
||||
proposal: proposal
|
||||
},
|
||||
success: function(data, textStatus, error) {
|
||||
// Reset the form.
|
||||
if (node_id) {
|
||||
hideProposeChange(node_id);
|
||||
}
|
||||
form.find('textarea')
|
||||
.val('')
|
||||
.add(form.find('input'))
|
||||
.removeAttr('disabled');
|
||||
var ul = $('#cl' + (node_id || parent_id));
|
||||
if (ul.data('empty')) {
|
||||
$(ul).empty();
|
||||
ul.data('empty', false);
|
||||
}
|
||||
insertComment(data.comment);
|
||||
var ao = $('#ao' + node_id);
|
||||
ao.find('img').attr({'src': opts.commentBrightImage});
|
||||
if (node_id) {
|
||||
// if this was a "root" comment, remove the commenting box
|
||||
// (the user can get it back by reopening the comment popup)
|
||||
$('#ca' + node_id).slideUp();
|
||||
}
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
form.find('textarea,input').removeAttr('disabled');
|
||||
showError('Oops, there was a problem adding the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively append comments to the main comment list and children
|
||||
* lists, creating the comment tree.
|
||||
*/
|
||||
function appendComments(comments, ul) {
|
||||
$.each(comments, function() {
|
||||
var div = createCommentDiv(this);
|
||||
ul.append($(document.createElement('li')).html(div));
|
||||
appendComments(this.children, div.find('ul.comment-children'));
|
||||
// To avoid stagnating data, don't store the comments children in data.
|
||||
this.children = null;
|
||||
div.data('comment', this);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* After adding a new comment, it must be inserted in the correct
|
||||
* location in the comment tree.
|
||||
*/
|
||||
function insertComment(comment) {
|
||||
var div = createCommentDiv(comment);
|
||||
|
||||
// To avoid stagnating data, don't store the comments children in data.
|
||||
comment.children = null;
|
||||
div.data('comment', comment);
|
||||
|
||||
var ul = $('#cl' + (comment.node || comment.parent));
|
||||
var siblings = getChildren(ul);
|
||||
|
||||
var li = $(document.createElement('li'));
|
||||
li.hide();
|
||||
|
||||
// Determine where in the parents children list to insert this comment.
|
||||
for(var i=0; i < siblings.length; i++) {
|
||||
if (comp(comment, siblings[i]) <= 0) {
|
||||
$('#cd' + siblings[i].id)
|
||||
.parent()
|
||||
.before(li.html(div));
|
||||
li.slideDown('fast');
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// If we get here, this comment rates lower than all the others,
|
||||
// or it is the only comment in the list.
|
||||
ul.append(li.html(div));
|
||||
li.slideDown('fast');
|
||||
}
|
||||
|
||||
function acceptComment(id) {
|
||||
$.ajax({
|
||||
type: 'POST',
|
||||
url: opts.acceptCommentURL,
|
||||
data: {id: id},
|
||||
success: function(data, textStatus, request) {
|
||||
$('#cm' + id).fadeOut('fast');
|
||||
$('#cd' + id).removeClass('moderate');
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem accepting the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function deleteComment(id) {
|
||||
$.ajax({
|
||||
type: 'POST',
|
||||
url: opts.deleteCommentURL,
|
||||
data: {id: id},
|
||||
success: function(data, textStatus, request) {
|
||||
var div = $('#cd' + id);
|
||||
if (data == 'delete') {
|
||||
// Moderator mode: remove the comment and all children immediately
|
||||
div.slideUp('fast', function() {
|
||||
div.remove();
|
||||
});
|
||||
return;
|
||||
}
|
||||
// User mode: only mark the comment as deleted
|
||||
div
|
||||
.find('span.user-id:first')
|
||||
.text('[deleted]').end()
|
||||
.find('div.comment-text:first')
|
||||
.text('[deleted]').end()
|
||||
.find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
|
||||
', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
|
||||
.remove();
|
||||
var comment = div.data('comment');
|
||||
comment.username = '[deleted]';
|
||||
comment.text = '[deleted]';
|
||||
div.data('comment', comment);
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem deleting the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function showProposal(id) {
|
||||
$('#sp' + id).hide();
|
||||
$('#hp' + id).show();
|
||||
$('#pr' + id).slideDown('fast');
|
||||
}
|
||||
|
||||
function hideProposal(id) {
|
||||
$('#hp' + id).hide();
|
||||
$('#sp' + id).show();
|
||||
$('#pr' + id).slideUp('fast');
|
||||
}
|
||||
|
||||
function showProposeChange(id) {
|
||||
$('#pc' + id).hide();
|
||||
$('#hc' + id).show();
|
||||
var textarea = $('#pt' + id);
|
||||
textarea.val(textarea.data('source'));
|
||||
$.fn.autogrow.resize(textarea[0]);
|
||||
textarea.slideDown('fast');
|
||||
}
|
||||
|
||||
function hideProposeChange(id) {
|
||||
$('#hc' + id).hide();
|
||||
$('#pc' + id).show();
|
||||
var textarea = $('#pt' + id);
|
||||
textarea.val('').removeAttr('disabled');
|
||||
textarea.slideUp('fast');
|
||||
}
|
||||
|
||||
function toggleCommentMarkupBox(id) {
|
||||
$('#mb' + id).toggle();
|
||||
}
|
||||
|
||||
/** Handle when the user clicks on a sort by link. */
|
||||
function handleReSort(link) {
|
||||
var classes = link.attr('class').split(/\s+/);
|
||||
for (var i=0; i<classes.length; i++) {
|
||||
if (classes[i] != 'sort-option') {
|
||||
by = classes[i].substring(2);
|
||||
}
|
||||
}
|
||||
setComparator();
|
||||
// Save/update the sortBy cookie.
|
||||
var expiration = new Date();
|
||||
expiration.setDate(expiration.getDate() + 365);
|
||||
document.cookie= 'sortBy=' + escape(by) +
|
||||
';expires=' + expiration.toUTCString();
|
||||
$('ul.comment-ul').each(function(index, ul) {
|
||||
var comments = getChildren($(ul), true);
|
||||
comments = sortComments(comments);
|
||||
appendComments(comments, $(ul).empty());
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to process a vote when a user clicks an arrow.
|
||||
*/
|
||||
function handleVote(link) {
|
||||
if (!opts.voting) {
|
||||
showError("You'll need to login to vote.");
|
||||
return;
|
||||
}
|
||||
|
||||
var id = link.attr('id');
|
||||
if (!id) {
|
||||
// Didn't click on one of the voting arrows.
|
||||
return;
|
||||
}
|
||||
// If it is an unvote, the new vote value is 0,
|
||||
// Otherwise it's 1 for an upvote, or -1 for a downvote.
|
||||
var value = 0;
|
||||
if (id.charAt(1) != 'u') {
|
||||
value = id.charAt(0) == 'u' ? 1 : -1;
|
||||
}
|
||||
// The data to be sent to the server.
|
||||
var d = {
|
||||
comment_id: id.substring(2),
|
||||
value: value
|
||||
};
|
||||
|
||||
// Swap the vote and unvote links.
|
||||
link.hide();
|
||||
$('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
|
||||
.show();
|
||||
|
||||
// The div the comment is displayed in.
|
||||
var div = $('div#cd' + d.comment_id);
|
||||
var data = div.data('comment');
|
||||
|
||||
// If this is not an unvote, and the other vote arrow has
|
||||
// already been pressed, unpress it.
|
||||
if ((d.value !== 0) && (data.vote === d.value * -1)) {
|
||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
|
||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
|
||||
}
|
||||
|
||||
// Update the comments rating in the local data.
|
||||
data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
|
||||
data.vote = d.value;
|
||||
div.data('comment', data);
|
||||
|
||||
// Change the rating text.
|
||||
div.find('.rating:first')
|
||||
.text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
|
||||
|
||||
// Send the vote information to the server.
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: opts.processVoteURL,
|
||||
data: d,
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem casting that vote.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Open a reply form used to reply to an existing comment.
|
||||
*/
|
||||
function openReply(id) {
|
||||
// Swap out the reply link for the hide link
|
||||
$('#rl' + id).hide();
|
||||
$('#cr' + id).show();
|
||||
|
||||
// Add the reply li to the children ul.
|
||||
var div = $(renderTemplate(replyTemplate, {id: id})).hide();
|
||||
$('#cl' + id)
|
||||
.prepend(div)
|
||||
// Setup the submit handler for the reply form.
|
||||
.find('#rf' + id)
|
||||
.submit(function(event) {
|
||||
event.preventDefault();
|
||||
addComment($('#rf' + id));
|
||||
closeReply(id);
|
||||
})
|
||||
.find('input[type=button]')
|
||||
.click(function() {
|
||||
closeReply(id);
|
||||
});
|
||||
div.slideDown('fast', function() {
|
||||
$('#rf' + id).find('textarea').focus();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Close the reply form opened with openReply.
|
||||
*/
|
||||
function closeReply(id) {
|
||||
// Remove the reply div from the DOM.
|
||||
$('#rd' + id).slideUp('fast', function() {
|
||||
$(this).remove();
|
||||
});
|
||||
|
||||
// Swap out the hide link for the reply link
|
||||
$('#cr' + id).hide();
|
||||
$('#rl' + id).show();
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively sort a tree of comments using the comp comparator.
|
||||
*/
|
||||
function sortComments(comments) {
|
||||
comments.sort(comp);
|
||||
$.each(comments, function() {
|
||||
this.children = sortComments(this.children);
|
||||
});
|
||||
return comments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the children comments from a ul. If recursive is true,
|
||||
* recursively include childrens' children.
|
||||
*/
|
||||
function getChildren(ul, recursive) {
|
||||
var children = [];
|
||||
ul.children().children("[id^='cd']")
|
||||
.each(function() {
|
||||
var comment = $(this).data('comment');
|
||||
if (recursive)
|
||||
comment.children = getChildren($(this).find('#cl' + comment.id), true);
|
||||
children.push(comment);
|
||||
});
|
||||
return children;
|
||||
}
|
||||
|
||||
/** Create a div to display a comment in. */
|
||||
function createCommentDiv(comment) {
|
||||
if (!comment.displayed && !opts.moderator) {
|
||||
return $('<div class="moderate">Thank you! Your comment will show up '
|
||||
+ 'once it is has been approved by a moderator.</div>');
|
||||
}
|
||||
// Prettify the comment rating.
|
||||
comment.pretty_rating = comment.rating + ' point' +
|
||||
(comment.rating == 1 ? '' : 's');
|
||||
// Make a class (for displaying not yet moderated comments differently)
|
||||
comment.css_class = comment.displayed ? '' : ' moderate';
|
||||
// Create a div for this comment.
|
||||
var context = $.extend({}, opts, comment);
|
||||
var div = $(renderTemplate(commentTemplate, context));
|
||||
|
||||
// If the user has voted on this comment, highlight the correct arrow.
|
||||
if (comment.vote) {
|
||||
var direction = (comment.vote == 1) ? 'u' : 'd';
|
||||
div.find('#' + direction + 'v' + comment.id).hide();
|
||||
div.find('#' + direction + 'u' + comment.id).show();
|
||||
}
|
||||
|
||||
if (opts.moderator || comment.text != '[deleted]') {
|
||||
div.find('a.reply').show();
|
||||
if (comment.proposal_diff)
|
||||
div.find('#sp' + comment.id).show();
|
||||
if (opts.moderator && !comment.displayed)
|
||||
div.find('#cm' + comment.id).show();
|
||||
if (opts.moderator || (opts.username == comment.username))
|
||||
div.find('#dc' + comment.id).show();
|
||||
}
|
||||
return div;
|
||||
}
|
||||
|
||||
/**
|
||||
* A simple template renderer. Placeholders such as <%id%> are replaced
|
||||
* by context['id'] with items being escaped. Placeholders such as <#id#>
|
||||
* are not escaped.
|
||||
*/
|
||||
function renderTemplate(template, context) {
|
||||
var esc = $(document.createElement('div'));
|
||||
|
||||
function handle(ph, escape) {
|
||||
var cur = context;
|
||||
$.each(ph.split('.'), function() {
|
||||
cur = cur[this];
|
||||
});
|
||||
return escape ? esc.text(cur || "").html() : cur;
|
||||
}
|
||||
|
||||
return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
|
||||
return handle(arguments[2], arguments[1] == '%' ? true : false);
|
||||
});
|
||||
}
|
||||
|
||||
/** Flash an error message briefly. */
|
||||
function showError(message) {
|
||||
$(document.createElement('div')).attr({'class': 'popup-error'})
|
||||
.append($(document.createElement('div'))
|
||||
.attr({'class': 'error-message'}).text(message))
|
||||
.appendTo('body')
|
||||
.fadeIn("slow")
|
||||
.delay(2000)
|
||||
.fadeOut("slow");
|
||||
}
|
||||
|
||||
/** Add a link the user uses to open the comments popup. */
|
||||
$.fn.comment = function() {
|
||||
return this.each(function() {
|
||||
var id = $(this).attr('id').substring(1);
|
||||
var count = COMMENT_METADATA[id];
|
||||
var title = count + ' comment' + (count == 1 ? '' : 's');
|
||||
var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
|
||||
var addcls = count == 0 ? ' nocomment' : '';
|
||||
$(this)
|
||||
.append(
|
||||
$(document.createElement('a')).attr({
|
||||
href: '#',
|
||||
'class': 'sphinx-comment-open' + addcls,
|
||||
id: 'ao' + id
|
||||
})
|
||||
.append($(document.createElement('img')).attr({
|
||||
src: image,
|
||||
alt: 'comment',
|
||||
title: title
|
||||
}))
|
||||
.click(function(event) {
|
||||
event.preventDefault();
|
||||
show($(this).attr('id').substring(2));
|
||||
})
|
||||
)
|
||||
.append(
|
||||
$(document.createElement('a')).attr({
|
||||
href: '#',
|
||||
'class': 'sphinx-comment-close hidden',
|
||||
id: 'ah' + id
|
||||
})
|
||||
.append($(document.createElement('img')).attr({
|
||||
src: opts.closeCommentImage,
|
||||
alt: 'close',
|
||||
title: 'close'
|
||||
}))
|
||||
.click(function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
})
|
||||
);
|
||||
});
|
||||
};
|
||||
|
||||
var opts = {
|
||||
processVoteURL: '/_process_vote',
|
||||
addCommentURL: '/_add_comment',
|
||||
getCommentsURL: '/_get_comments',
|
||||
acceptCommentURL: '/_accept_comment',
|
||||
deleteCommentURL: '/_delete_comment',
|
||||
commentImage: '/static/_static/comment.png',
|
||||
closeCommentImage: '/static/_static/comment-close.png',
|
||||
loadingImage: '/static/_static/ajax-loader.gif',
|
||||
commentBrightImage: '/static/_static/comment-bright.png',
|
||||
upArrow: '/static/_static/up.png',
|
||||
downArrow: '/static/_static/down.png',
|
||||
upArrowPressed: '/static/_static/up-pressed.png',
|
||||
downArrowPressed: '/static/_static/down-pressed.png',
|
||||
voting: false,
|
||||
moderator: false
|
||||
};
|
||||
|
||||
if (typeof COMMENT_OPTIONS != "undefined") {
|
||||
opts = jQuery.extend(opts, COMMENT_OPTIONS);
|
||||
}
|
||||
|
||||
var popupTemplate = '\
|
||||
<div class="sphinx-comments" id="sc<%id%>">\
|
||||
<p class="sort-options">\
|
||||
Sort by:\
|
||||
<a href="#" class="sort-option byrating">best rated</a>\
|
||||
<a href="#" class="sort-option byascage">newest</a>\
|
||||
<a href="#" class="sort-option byage">oldest</a>\
|
||||
</p>\
|
||||
<div class="comment-header">Comments</div>\
|
||||
<div class="comment-loading" id="cn<%id%>">\
|
||||
loading comments... <img src="<%loadingImage%>" alt="" /></div>\
|
||||
<ul id="cl<%id%>" class="comment-ul"></ul>\
|
||||
<div id="ca<%id%>">\
|
||||
<p class="add-a-comment">Add a comment\
|
||||
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
|
||||
<div class="comment-markup-box" id="mb<%id%>">\
|
||||
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
|
||||
<code>``code``</code>, \
|
||||
code blocks: <code>::</code> and an indented block after blank line</div>\
|
||||
<form method="post" id="cf<%id%>" class="comment-form" action="">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<p class="propose-button">\
|
||||
<a href="#" id="pc<%id%>" class="show-propose-change">\
|
||||
Propose a change ▹\
|
||||
</a>\
|
||||
<a href="#" id="hc<%id%>" class="hide-propose-change">\
|
||||
Propose a change ▿\
|
||||
</a>\
|
||||
</p>\
|
||||
<textarea name="proposal" id="pt<%id%>" cols="80"\
|
||||
spellcheck="false"></textarea>\
|
||||
<input type="submit" value="Add comment" />\
|
||||
<input type="hidden" name="node" value="<%id%>" />\
|
||||
<input type="hidden" name="parent" value="" />\
|
||||
</form>\
|
||||
</div>\
|
||||
</div>';
|
||||
|
||||
var commentTemplate = '\
|
||||
<div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
|
||||
<div class="vote">\
|
||||
<div class="arrow">\
|
||||
<a href="#" id="uv<%id%>" class="vote" title="vote up">\
|
||||
<img src="<%upArrow%>" />\
|
||||
</a>\
|
||||
<a href="#" id="uu<%id%>" class="un vote" title="vote up">\
|
||||
<img src="<%upArrowPressed%>" />\
|
||||
</a>\
|
||||
</div>\
|
||||
<div class="arrow">\
|
||||
<a href="#" id="dv<%id%>" class="vote" title="vote down">\
|
||||
<img src="<%downArrow%>" id="da<%id%>" />\
|
||||
</a>\
|
||||
<a href="#" id="du<%id%>" class="un vote" title="vote down">\
|
||||
<img src="<%downArrowPressed%>" />\
|
||||
</a>\
|
||||
</div>\
|
||||
</div>\
|
||||
<div class="comment-content">\
|
||||
<p class="tagline comment">\
|
||||
<span class="user-id"><%username%></span>\
|
||||
<span class="rating"><%pretty_rating%></span>\
|
||||
<span class="delta"><%time.delta%></span>\
|
||||
</p>\
|
||||
<div class="comment-text comment"><#text#></div>\
|
||||
<p class="comment-opts comment">\
|
||||
<a href="#" class="reply hidden" id="rl<%id%>">reply ▹</a>\
|
||||
<a href="#" class="close-reply" id="cr<%id%>">reply ▿</a>\
|
||||
<a href="#" id="sp<%id%>" class="show-proposal">proposal ▹</a>\
|
||||
<a href="#" id="hp<%id%>" class="hide-proposal">proposal ▿</a>\
|
||||
<a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
|
||||
<span id="cm<%id%>" class="moderation hidden">\
|
||||
<a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
|
||||
</span>\
|
||||
</p>\
|
||||
<pre class="proposal" id="pr<%id%>">\
|
||||
<#proposal_diff#>\
|
||||
</pre>\
|
||||
<ul class="comment-children" id="cl<%id%>"></ul>\
|
||||
</div>\
|
||||
<div class="clearleft"></div>\
|
||||
</div>\
|
||||
</div>';
|
||||
|
||||
var replyTemplate = '\
|
||||
<li>\
|
||||
<div class="reply-div" id="rd<%id%>">\
|
||||
<form id="rf<%id%>">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<input type="submit" value="Add reply" />\
|
||||
<input type="button" value="Cancel" />\
|
||||
<input type="hidden" name="parent" value="<%id%>" />\
|
||||
<input type="hidden" name="node" value="" />\
|
||||
</form>\
|
||||
</div>\
|
||||
</li>';
|
||||
|
||||
$(document).ready(function() {
|
||||
init();
|
||||
});
|
||||
})(jQuery);
|
||||
|
||||
$(document).ready(function() {
|
||||
// add comment anchors for all paragraphs that are commentable
|
||||
$('.sphinx-has-comment').comment();
|
||||
|
||||
// highlight search words in search results
|
||||
$("div.context").each(function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.q) ? params.q[0].split(/\s+/) : [];
|
||||
var result = $(this);
|
||||
$.each(terms, function() {
|
||||
result.highlightText(this.toLowerCase(), 'highlighted');
|
||||
});
|
||||
});
|
||||
|
||||
// directly open comment window if requested
|
||||
var anchor = document.location.hash;
|
||||
if (anchor.substring(0, 9) == '#comment-') {
|
||||
$('#ao' + anchor.substring(9)).click();
|
||||
document.location.hash = '#s' + anchor.substring(9);
|
||||
}
|
||||
});
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
<title>com package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -288,6 +288,7 @@
|
||||
<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>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.interposition_client">com.vmware.vapi.std.interposition_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -415,6 +416,11 @@
|
||||
<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>
|
||||
@ -427,7 +433,6 @@
|
||||
<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>
|
||||
|
||||
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.networking package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
<title>com.vmware.appliance.networking package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -182,7 +182,7 @@
|
||||
<span id="com-vmware-appliance-networking-dns-client-module"></span><h2>com.vmware.appliance.networking.dns_client module<a class="headerlink" href="#module-com.vmware.appliance.networking.dns_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Domains">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.networking.dns_client.</code><code class="descname">Domains</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Domains" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking.dns_client.</code><code class="sig-name descname">Domains</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Domains" 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><code class="docutils literal notranslate"><span class="pre">Domains</span></code> class provides methods DNS search domains.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -192,7 +192,7 @@
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Domains.add">
|
||||
<code class="descname">add</code><span class="sig-paren">(</span><em>domain</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Domains.add" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">domain</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Domains.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add domain to DNS search domains.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -207,7 +207,7 @@ Generic error</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Domains.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Domains.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Domains.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get list of DNS search domains.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
@ -225,7 +225,7 @@ Generic error</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Domains.set">
|
||||
<code class="descname">set</code><span class="sig-paren">(</span><em>domains</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Domains.set" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">domains</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Domains.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set DNS search domains.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -242,7 +242,7 @@ Generic error</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.networking.dns_client.</code><code class="descname">Hostname</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking.dns_client.</code><code class="sig-name descname">Hostname</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname" 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><code class="docutils literal notranslate"><span class="pre">Hostname</span></code> class provides methods Performs operations on Fully Qualified
|
||||
Doman Name.</p>
|
||||
@ -253,7 +253,7 @@ Doman Name.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname.Message">
|
||||
<em class="property">class </em><code class="descname">Message</code><span class="sig-paren">(</span><em>message=None</em>, <em>result=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.Message" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Message</code><span class="sig-paren">(</span><em class="sig-param">message=None</em>, <em class="sig-param">result=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.Message" 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><code class="docutils literal notranslate"><span class="pre">Hostname.Message</span></code> class Test result and message</p>
|
||||
<div class="admonition tip">
|
||||
@ -273,7 +273,7 @@ names.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname.MessageStatus">
|
||||
<em class="property">class </em><code class="descname">MessageStatus</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.MessageStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">MessageStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.MessageStatus" 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><code class="docutils literal notranslate"><span class="pre">Hostname.MessageStatus</span></code> class Individual test result</p>
|
||||
<div class="admonition note">
|
||||
@ -293,13 +293,13 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname.MessageStatus.failure">
|
||||
<code class="descname">failure</code><em class="property"> = MessageStatus(string='failure')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.MessageStatus.failure" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">failure</code><em class="property"> = MessageStatus(string='failure')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.MessageStatus.failure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>message indicates the test failed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname.MessageStatus.success">
|
||||
<code class="descname">success</code><em class="property"> = MessageStatus(string='success')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.MessageStatus.success" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">success</code><em class="property"> = MessageStatus(string='success')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.MessageStatus.success" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>message indicates that the test was successful.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -307,7 +307,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname.TestStatus">
|
||||
<em class="property">class </em><code class="descname">TestStatus</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">TestStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus" 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><code class="docutils literal notranslate"><span class="pre">Hostname.TestStatus</span></code> class Health indicator</p>
|
||||
<div class="admonition note">
|
||||
@ -327,20 +327,20 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname.TestStatus.green">
|
||||
<code class="descname">green</code><em class="property"> = TestStatus(string='green')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus.green" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">green</code><em class="property"> = TestStatus(string='green')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus.green" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>All tests were successful for given data</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname.TestStatus.orange">
|
||||
<code class="descname">orange</code><em class="property"> = TestStatus(string='orange')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus.orange" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">orange</code><em class="property"> = TestStatus(string='orange')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus.orange" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>In case data has more than one test, this indicates not all tests were
|
||||
successful</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname.TestStatus.red">
|
||||
<code class="descname">red</code><em class="property"> = TestStatus(string='red')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus.red" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">red</code><em class="property"> = TestStatus(string='red')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatus.red" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>All tests failed for given data</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -348,7 +348,7 @@ successful</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname.TestStatusInfo">
|
||||
<em class="property">class </em><code class="descname">TestStatusInfo</code><span class="sig-paren">(</span><em>status=None</em>, <em>messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatusInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">TestStatusInfo</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.TestStatusInfo" 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><code class="docutils literal notranslate"><span class="pre">Hostname.TestStatusInfo</span></code> class Overall test result</p>
|
||||
<div class="admonition tip">
|
||||
@ -368,7 +368,7 @@ names.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the Fully Qualified Doman Name.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
@ -386,7 +386,7 @@ Generic error</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname.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.networking.dns_client.Hostname.set" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the Fully Qualified Domain Name.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -401,7 +401,7 @@ Generic error</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Hostname.test">
|
||||
<code class="descname">test</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.test" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">test</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Hostname.test" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the Fully Qualified Domain Name.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -424,7 +424,7 @@ Generic error</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.networking.dns_client.</code><code class="descname">Servers</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking.dns_client.</code><code class="sig-name descname">Servers</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers" 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><code class="docutils literal notranslate"><span class="pre">Servers</span></code> class provides methods DNS server configuration.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -434,7 +434,7 @@ Generic error</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig">
|
||||
<em class="property">class </em><code class="descname">DNSServerConfig</code><span class="sig-paren">(</span><em>mode=None</em>, <em>servers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">DNSServerConfig</code><span class="sig-paren">(</span><em class="sig-param">mode=None</em>, <em class="sig-param">servers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig" 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><code class="docutils literal notranslate"><span class="pre">Servers.DNSServerConfig</span></code> class This structure represents the
|
||||
configuration state used to determine DNS servers.</p>
|
||||
@ -458,7 +458,7 @@ comma-separated list of DNS servers if the mode argument is
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.DNSServerMode">
|
||||
<em class="property">class </em><code class="descname">DNSServerMode</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">DNSServerMode</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode" 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><code class="docutils literal notranslate"><span class="pre">Servers.DNSServerMode</span></code> class Describes DNS Server source (DHCP,static)</p>
|
||||
<div class="admonition note">
|
||||
@ -478,13 +478,13 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.DNSServerMode.dhcp">
|
||||
<code class="descname">dhcp</code><em class="property"> = DNSServerMode(string='dhcp')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode.dhcp" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">dhcp</code><em class="property"> = DNSServerMode(string='dhcp')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode.dhcp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>DNS address is automatically assigned by a DHCP server.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.DNSServerMode.is_static">
|
||||
<code class="descname">is_static</code><em class="property"> = DNSServerMode(string='is_static')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode.is_static" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">is_static</code><em class="property"> = DNSServerMode(string='is_static')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.DNSServerMode.is_static" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>DNS address is static.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -492,7 +492,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.Message">
|
||||
<em class="property">class </em><code class="descname">Message</code><span class="sig-paren">(</span><em>message=None</em>, <em>result=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.Message" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Message</code><span class="sig-paren">(</span><em class="sig-param">message=None</em>, <em class="sig-param">result=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.Message" 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><code class="docutils literal notranslate"><span class="pre">Servers.Message</span></code> class Test result and message</p>
|
||||
<div class="admonition tip">
|
||||
@ -512,7 +512,7 @@ names.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.MessageStatus">
|
||||
<em class="property">class </em><code class="descname">MessageStatus</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.MessageStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">MessageStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.MessageStatus" 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><code class="docutils literal notranslate"><span class="pre">Servers.MessageStatus</span></code> class Individual test result</p>
|
||||
<div class="admonition note">
|
||||
@ -532,13 +532,13 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.MessageStatus.failure">
|
||||
<code class="descname">failure</code><em class="property"> = MessageStatus(string='failure')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.MessageStatus.failure" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">failure</code><em class="property"> = MessageStatus(string='failure')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.MessageStatus.failure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>message indicates the test failed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.MessageStatus.success">
|
||||
<code class="descname">success</code><em class="property"> = MessageStatus(string='success')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.MessageStatus.success" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">success</code><em class="property"> = MessageStatus(string='success')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.MessageStatus.success" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>message indicates that the test was successful.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -546,7 +546,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.TestStatus">
|
||||
<em class="property">class </em><code class="descname">TestStatus</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">TestStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus" 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><code class="docutils literal notranslate"><span class="pre">Servers.TestStatus</span></code> class Health indicator</p>
|
||||
<div class="admonition note">
|
||||
@ -566,20 +566,20 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.TestStatus.green">
|
||||
<code class="descname">green</code><em class="property"> = TestStatus(string='green')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus.green" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">green</code><em class="property"> = TestStatus(string='green')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus.green" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>All tests were successful for given data</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.TestStatus.orange">
|
||||
<code class="descname">orange</code><em class="property"> = TestStatus(string='orange')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus.orange" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">orange</code><em class="property"> = TestStatus(string='orange')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus.orange" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>In case data has more than one test, this indicates not all tests were
|
||||
successful</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.TestStatus.red">
|
||||
<code class="descname">red</code><em class="property"> = TestStatus(string='red')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus.red" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">red</code><em class="property"> = TestStatus(string='red')</em><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatus.red" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>All tests failed for given data</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -587,7 +587,7 @@ successful</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.TestStatusInfo">
|
||||
<em class="property">class </em><code class="descname">TestStatusInfo</code><span class="sig-paren">(</span><em>status=None</em>, <em>messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatusInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">TestStatusInfo</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.TestStatusInfo" 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><code class="docutils literal notranslate"><span class="pre">Servers.TestStatusInfo</span></code> class Overall test result</p>
|
||||
<div class="admonition tip">
|
||||
@ -607,7 +607,7 @@ names.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.add">
|
||||
<code class="descname">add</code><span class="sig-paren">(</span><em>server</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.add" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">server</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add a DNS server. This method fails if mode argument is “dhcp”</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -622,7 +622,7 @@ Generic error</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get DNS server configuration.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
@ -640,7 +640,7 @@ Generic error</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.set">
|
||||
<code class="descname">set</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.set" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the DNS server configuration. If you set the mode argument to
|
||||
“DHCP”, a DHCP refresh is forced.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -656,7 +656,7 @@ Generic error</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.Servers.test">
|
||||
<code class="descname">test</code><span class="sig-paren">(</span><em>servers</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.test" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">test</code><span class="sig-paren">(</span><em class="sig-param">servers</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_client.Servers.test" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test if dns servers are reachable.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -679,7 +679,7 @@ Generic error</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.dns_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.networking.dns_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.networking.dns_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking.dns_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.dns_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">
|
||||
@ -694,7 +694,7 @@ Generic error</p>
|
||||
<span id="com-vmware-appliance-networking-firewall-client-module"></span><h2>com.vmware.appliance.networking.firewall_client module<a class="headerlink" href="#module-com.vmware.appliance.networking.firewall_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.firewall_client.Inbound">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.networking.firewall_client.</code><code class="descname">Inbound</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking.firewall_client.</code><code class="sig-name descname">Inbound</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound" 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">Inbound</span></code> class provides methods to manage inbound firewall rules.
|
||||
This class was added in vSphere API 6.7.1.</p>
|
||||
@ -705,7 +705,7 @@ This class was added in vSphere API 6.7.1.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.firewall_client.Inbound.Policy">
|
||||
<em class="property">class </em><code class="descname">Policy</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Policy</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy" 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><code class="docutils literal notranslate"><span class="pre">Inbound.Policy</span></code> class Defines firewall rule policies. This enumeration
|
||||
was added in vSphere API 6.7.1.</p>
|
||||
@ -726,28 +726,28 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.firewall_client.Inbound.Policy.ACCEPT">
|
||||
<code class="descname">ACCEPT</code><em class="property"> = Policy(string='ACCEPT')</em><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy.ACCEPT" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">ACCEPT</code><em class="property"> = Policy(string='ACCEPT')</em><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy.ACCEPT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allow packet with corresponding address. This class attribute was added in
|
||||
vSphere API 6.7.1.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.firewall_client.Inbound.Policy.IGNORE">
|
||||
<code class="descname">IGNORE</code><em class="property"> = Policy(string='IGNORE')</em><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy.IGNORE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">IGNORE</code><em class="property"> = Policy(string='IGNORE')</em><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy.IGNORE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Drop packet with correpsonding address. This class attribute was added in
|
||||
vSphere API 6.7.1.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.firewall_client.Inbound.Policy.REJECT">
|
||||
<code class="descname">REJECT</code><em class="property"> = Policy(string='REJECT')</em><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy.REJECT" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">REJECT</code><em class="property"> = Policy(string='REJECT')</em><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy.REJECT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Drop packet with corresponding address sending destination is not
|
||||
reachable. This class attribute was added in vSphere API 6.7.1.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.firewall_client.Inbound.Policy.RETURN">
|
||||
<code class="descname">RETURN</code><em class="property"> = Policy(string='RETURN')</em><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy.RETURN" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RETURN</code><em class="property"> = Policy(string='RETURN')</em><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Policy.RETURN" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Apply default or port-specific rules to packet with corresponding address.
|
||||
This class attribute was added in vSphere API 6.7.1.</p>
|
||||
</dd></dl>
|
||||
@ -756,7 +756,7 @@ This class attribute was added in vSphere API 6.7.1.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.firewall_client.Inbound.Rule">
|
||||
<em class="property">class </em><code class="descname">Rule</code><span class="sig-paren">(</span><em>address=None</em>, <em>prefix=None</em>, <em>policy=None</em>, <em>interface_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Rule" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Rule</code><span class="sig-paren">(</span><em class="sig-param">address=None</em>, <em class="sig-param">prefix=None</em>, <em class="sig-param">policy=None</em>, <em class="sig-param">interface_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.Rule" 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><code class="docutils literal notranslate"><span class="pre">Inbound.Rule</span></code> class Structure that defines a single address-based
|
||||
firewall rule. This class was added in vSphere API 6.7.1.</p>
|
||||
@ -785,7 +785,7 @@ in vSphere API 6.7.1.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.firewall_client.Inbound.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ordered list of firewall rules. Within the list of traffic
|
||||
rules, rules are processed in order of appearance, from top to bottom.
|
||||
When a connection matches a firewall rule, further processing for the
|
||||
@ -807,13 +807,13 @@ Generic error</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.firewall_client.Inbound.set">
|
||||
<code class="descname">set</code><span class="sig-paren">(</span><em>rules</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.set" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">rules</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_client.Inbound.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the ordered list of firewall rules to allow or deny traffic from
|
||||
one or more incoming IP addresses. This overwrites the existing
|
||||
firewall rules and creates a new rule list. Within the list of traffic
|
||||
rules, rules are processed in order of appearance, from top to bottom.
|
||||
For example, the list of rules can be as follows:</p>
|
||||
<table class="docutils align-center">
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 27%" />
|
||||
<col style="width: 18%" />
|
||||
@ -863,7 +863,7 @@ Generic error</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.firewall_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.networking.firewall_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.networking.firewall_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking.firewall_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.firewall_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">
|
||||
@ -878,7 +878,7 @@ Generic error</p>
|
||||
<span id="com-vmware-appliance-networking-interfaces-client-module"></span><h2>com.vmware.appliance.networking.interfaces_client module<a class="headerlink" href="#module-com.vmware.appliance.networking.interfaces_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv4">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.networking.interfaces_client.</code><code class="descname">Ipv4</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking.interfaces_client.</code><code class="sig-name descname">Ipv4</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4" 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">Ipv4</span></code> class provides methods to perform IPv4 network configuration
|
||||
for interfaces. This class was added in vSphere API 6.7.</p>
|
||||
@ -889,7 +889,7 @@ for interfaces. This class was added in vSphere API 6.7.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv4.Config">
|
||||
<em class="property">class </em><code class="descname">Config</code><span class="sig-paren">(</span><em>mode=None</em>, <em>address=None</em>, <em>prefix=None</em>, <em>default_gateway=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Config" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param">mode=None</em>, <em class="sig-param">address=None</em>, <em class="sig-param">prefix=None</em>, <em class="sig-param">default_gateway=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Config" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv4.Config</span></code> class provides defines the IPv4 configuration of a
|
||||
network interface. This class was added in vSphere API 6.7.</p>
|
||||
@ -927,7 +927,7 @@ If None, the defaultGateway was never set.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv4.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>configurable=None</em>, <em>mode=None</em>, <em>address=None</em>, <em>prefix=None</em>, <em>default_gateway=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">configurable=None</em>, <em class="sig-param">mode=None</em>, <em class="sig-param">address=None</em>, <em class="sig-param">prefix=None</em>, <em class="sig-param">default_gateway=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.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">Ipv4.Info</span></code> class defines current IPv4 configuration state of a
|
||||
network interface. This class was added in vSphere API 6.7.</p>
|
||||
@ -971,7 +971,7 @@ of <code class="docutils literal notranslate"><span class="pre">mode</span></cod
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode">
|
||||
<em class="property">class </em><code class="descname">Mode</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Mode</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode" 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">Ipv4.Mode</span></code> class defines different IPv4 address assignment modes.
|
||||
This enumeration was added in vSphere API 6.7.</p>
|
||||
@ -992,21 +992,21 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.DHCP">
|
||||
<code class="descname">DHCP</code><em class="property"> = Mode(string='DHCP')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.DHCP" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">DHCP</code><em class="property"> = Mode(string='DHCP')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.DHCP" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv4 address is automatically assigned by a DHCP server. This class
|
||||
attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC">
|
||||
<code class="descname">STATIC</code><em class="property"> = Mode(string='STATIC')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">STATIC</code><em class="property"> = Mode(string='STATIC')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.STATIC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv4 address is static. This class attribute was added in vSphere API
|
||||
6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.UNCONFIGURED">
|
||||
<code class="descname">UNCONFIGURED</code><em class="property"> = Mode(string='UNCONFIGURED')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.UNCONFIGURED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">UNCONFIGURED</code><em class="property"> = Mode(string='UNCONFIGURED')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.Mode.UNCONFIGURED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv4 protocol is not configured. This class attribute was added in
|
||||
vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
@ -1015,7 +1015,7 @@ vSphere API 6.7.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv4.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>interface_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">interface_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get IPv4 network configuration for specific NIC. This method was added
|
||||
in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -1043,7 +1043,7 @@ Generic error.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv4.set">
|
||||
<code class="descname">set</code><span class="sig-paren">(</span><em>interface_name</em>, <em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.set" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">interface_name</em>, <em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv4.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set IPv4 network configuration for specific network interface. This
|
||||
method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -1078,7 +1078,7 @@ Generic error.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.networking.interfaces_client.</code><code class="descname">Ipv6</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking.interfaces_client.</code><code class="sig-name descname">Ipv6</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6" 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">Ipv6</span></code> class provides methods to perform IPv6 network configuration
|
||||
for interfaces. This class was added in vSphere API 6.7.</p>
|
||||
@ -1089,7 +1089,7 @@ for interfaces. This class was added in vSphere API 6.7.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Address">
|
||||
<em class="property">class </em><code class="descname">Address</code><span class="sig-paren">(</span><em>address=None</em>, <em>prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Address" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Address</code><span class="sig-paren">(</span><em class="sig-param">address=None</em>, <em class="sig-param">prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Address" 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">Ipv6.Address</span></code> class provides the structure used to name an IPv6
|
||||
address. This class was added in vSphere API 6.7.</p>
|
||||
@ -1112,7 +1112,7 @@ vSphere API 6.7.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.AddressInfo">
|
||||
<em class="property">class </em><code class="descname">AddressInfo</code><span class="sig-paren">(</span><em>origin=None</em>, <em>status=None</em>, <em>address=None</em>, <em>prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.AddressInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">AddressInfo</code><span class="sig-paren">(</span><em class="sig-param">origin=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">address=None</em>, <em class="sig-param">prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.AddressInfo" 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">Ipv6.AddressInfo</span></code> class provides the structure that you can use to
|
||||
get information about an IPv6 address along with its origin and status.
|
||||
@ -1140,7 +1140,7 @@ vSphere API 6.7.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Config">
|
||||
<em class="property">class </em><code class="descname">Config</code><span class="sig-paren">(</span><em>dhcp=None</em>, <em>autoconf=None</em>, <em>addresses=None</em>, <em>default_gateway=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Config" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param">dhcp=None</em>, <em class="sig-param">autoconf=None</em>, <em class="sig-param">addresses=None</em>, <em class="sig-param">default_gateway=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Config" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6.Config</span></code> class provides the structure that you can use to
|
||||
configure IPv6 on a particular interface. Addresses can be assigned by
|
||||
@ -1175,7 +1175,7 @@ added in vSphere API 6.7.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>dhcp=None</em>, <em>autoconf=None</em>, <em>addresses=None</em>, <em>default_gateway=None</em>, <em>configurable=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">dhcp=None</em>, <em class="sig-param">autoconf=None</em>, <em class="sig-param">addresses=None</em>, <em class="sig-param">default_gateway=None</em>, <em class="sig-param">configurable=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.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">Ipv6.Info</span></code> class provides the structure that defines an existing
|
||||
IPv6 configuration on a particular interface. This structure is read only.
|
||||
@ -1210,7 +1210,7 @@ added in vSphere API 6.7.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin">
|
||||
<em class="property">class </em><code class="descname">Origin</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Origin</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin" 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">Ipv6.Origin</span></code> class defines IPv6 address origin values. This
|
||||
enumeration was added in vSphere API 6.7.</p>
|
||||
@ -1231,21 +1231,21 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.DHCP">
|
||||
<code class="descname">DHCP</code><em class="property"> = Origin(string='DHCP')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.DHCP" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">DHCP</code><em class="property"> = Origin(string='DHCP')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.DHCP" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv6 address is assigned by a DHCP server. See RFC 4293. This class
|
||||
attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.LINKLAYER">
|
||||
<code class="descname">LINKLAYER</code><em class="property"> = Origin(string='LINKLAYER')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.LINKLAYER" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">LINKLAYER</code><em class="property"> = Origin(string='LINKLAYER')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.LINKLAYER" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv6 address is assigned by IPv6 Stateless Address Auto-configuration
|
||||
(SLAAC). See RFC 4293. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.MANUAL">
|
||||
<code class="descname">MANUAL</code><em class="property"> = Origin(string='MANUAL')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.MANUAL" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">MANUAL</code><em class="property"> = Origin(string='MANUAL')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.MANUAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv6 address was manually configured to a specified address, for
|
||||
example, by user configuration. See RFC 4293. This class attribute was
|
||||
added in vSphere API 6.7.</p>
|
||||
@ -1253,14 +1253,14 @@ added in vSphere API 6.7.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.OTHER">
|
||||
<code class="descname">OTHER</code><em class="property"> = Origin(string='OTHER')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.OTHER" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">OTHER</code><em class="property"> = Origin(string='OTHER')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.OTHER" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv6 address is assigned by a mechanism other than manual, DHCP, SLAAC,
|
||||
or random. See RFC 4293. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.RANDOM">
|
||||
<code class="descname">RANDOM</code><em class="property"> = Origin(string='RANDOM')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.RANDOM" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RANDOM</code><em class="property"> = Origin(string='RANDOM')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Origin.RANDOM" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv6 address is assigned randomly by the system. See RFC 4293. This
|
||||
class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
@ -1269,7 +1269,7 @@ class attribute was added in vSphere API 6.7.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status">
|
||||
<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.appliance.networking.interfaces_client.Ipv6.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.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>The <code class="docutils literal notranslate"><span class="pre">Ipv6.Status</span></code> class defines IPv6 address status values. See RFC 4293.
|
||||
This enumeration was added in vSphere API 6.7.</p>
|
||||
@ -1290,7 +1290,7 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.DEPRECATED">
|
||||
<code class="descname">DEPRECATED</code><em class="property"> = Status(string='DEPRECATED')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.DEPRECATED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">DEPRECATED</code><em class="property"> = Status(string='DEPRECATED')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.DEPRECATED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The is a valid but deprecated IPv6 address. This address cannot be used as
|
||||
a source address in new communications, although packets addressed to such
|
||||
an address are processed as expected. This class attribute was added in
|
||||
@ -1299,14 +1299,14 @@ vSphere API 6.7.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.DUPLICATE">
|
||||
<code class="descname">DUPLICATE</code><em class="property"> = Status(string='DUPLICATE')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.DUPLICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">DUPLICATE</code><em class="property"> = Status(string='DUPLICATE')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.DUPLICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv6 address is not unique on the link and cannot be used. This class
|
||||
attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.INACCESSIBLE">
|
||||
<code class="descname">INACCESSIBLE</code><em class="property"> = Status(string='INACCESSIBLE')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.INACCESSIBLE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">INACCESSIBLE</code><em class="property"> = Status(string='INACCESSIBLE')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.INACCESSIBLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv6 address is inaccessible because the interface to which this
|
||||
address is assigned is not operational. This class attribute was added in
|
||||
vSphere API 6.7.</p>
|
||||
@ -1314,7 +1314,7 @@ vSphere API 6.7.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.INVALID">
|
||||
<code class="descname">INVALID</code><em class="property"> = Status(string='INVALID')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.INVALID" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">INVALID</code><em class="property"> = Status(string='INVALID')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.INVALID" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv6 address is not a valid address. It should not appear as the
|
||||
destination or source address of a packet. This class attribute was added
|
||||
in vSphere API 6.7.</p>
|
||||
@ -1322,7 +1322,7 @@ in vSphere API 6.7.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.OPTIMISTIC">
|
||||
<code class="descname">OPTIMISTIC</code><em class="property"> = Status(string='OPTIMISTIC')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.OPTIMISTIC" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">OPTIMISTIC</code><em class="property"> = Status(string='OPTIMISTIC')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.OPTIMISTIC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv6 address is available for use, subject to restrictions, while its
|
||||
uniqueness on a link is being verified. This class attribute was added in
|
||||
vSphere API 6.7.</p>
|
||||
@ -1330,14 +1330,14 @@ vSphere API 6.7.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.PREFERRED">
|
||||
<code class="descname">PREFERRED</code><em class="property"> = Status(string='PREFERRED')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.PREFERRED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">PREFERRED</code><em class="property"> = Status(string='PREFERRED')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.PREFERRED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is a valid IPv6 address that can appear as the destination or source
|
||||
address of a packet. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.TENTATIVE">
|
||||
<code class="descname">TENTATIVE</code><em class="property"> = Status(string='TENTATIVE')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.TENTATIVE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">TENTATIVE</code><em class="property"> = Status(string='TENTATIVE')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.TENTATIVE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The IPv6 address is in the process of being verified as unique. An address
|
||||
in this state cannot be used for general communication. It can be used to
|
||||
determine the uniqueness of the address. This class attribute was added in
|
||||
@ -1346,7 +1346,7 @@ vSphere API 6.7.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.Status.UNKNOWN">
|
||||
<code class="descname">UNKNOWN</code><em class="property"> = Status(string='UNKNOWN')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">UNKNOWN</code><em class="property"> = Status(string='UNKNOWN')</em><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.Status.UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The status of this address cannot be determined. This class attribute was
|
||||
added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
@ -1355,7 +1355,7 @@ added in vSphere API 6.7.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>interface_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">interface_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get IPv6 network configuration for specific interface. This method was
|
||||
added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -1383,7 +1383,7 @@ Generic error.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.Ipv6.set">
|
||||
<code class="descname">set</code><span class="sig-paren">(</span><em>interface_name</em>, <em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.set" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">interface_name</em>, <em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.Ipv6.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set IPv6 network configuration for specific interface. This method was
|
||||
added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -1414,7 +1414,7 @@ Generic error.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.networking.interfaces_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.networking.interfaces_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.networking.interfaces_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.networking.interfaces_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.appliance.recovery.backup package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -184,7 +184,7 @@
|
||||
<span id="com-vmware-appliance-recovery-backup-job-client-module"></span><h2>com.vmware.appliance.recovery.backup.job_client module<a class="headerlink" href="#module-com.vmware.appliance.recovery.backup.job_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup.job_client.</code><code class="sig-name descname">Details</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -195,7 +195,7 @@ jobs. This class was added in vSphere API 6.7.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">BuildInfo</code><span class="sig-paren">(</span><em class="sig-param">version_name=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">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>
|
||||
@ -220,7 +220,7 @@ API 6.7.2.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">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
|
||||
@ -247,7 +247,7 @@ If None the filter will match all the backup jobs.</p>
|
||||
|
||||
<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>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>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">location=None</em>, <em class="sig-param">duration=None</em>, <em class="sig-param">size=None</em>, <em class="sig-param">progress=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">messages=None</em>, <em class="sig-param">build=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">operation=None</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">target=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">cancelable=None</em>, <em class="sig-param">error=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">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>
|
||||
@ -346,7 +346,7 @@ system.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.Type">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -367,13 +367,13 @@ type description page</span></a>.</p>
|
||||
</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>
|
||||
<code class="sig-name 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></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>
|
||||
<code class="sig-name 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></dl>
|
||||
|
||||
@ -381,7 +381,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="method">
|
||||
<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>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
@ -411,7 +411,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.job_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup.job_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
@ -426,7 +426,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
<span id="com-vmware-appliance-recovery-backup-system-name-client-module"></span><h2>com.vmware.appliance.recovery.backup.system_name_client module<a class="headerlink" href="#module-com.vmware.appliance.recovery.backup.system_name_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.Archive">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup.system_name_client.</code><code class="sig-name descname">Archive</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -437,7 +437,7 @@ class was added in vSphere API 6.7.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">start_timestamp=None</em>, <em class="sig-param">end_timestamp=None</em>, <em class="sig-param">comment_substring=None</em>, <em class="sig-param">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>
|
||||
<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.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
|
||||
@ -470,7 +470,7 @@ If None it defaults to 128.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.Archive.Info">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">timestamp=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">parts=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">system_name=None</em>, <em class="sig-param">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>
|
||||
@ -506,7 +506,7 @@ was added in vSphere API 6.7.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.Archive.Summary">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">archive=None</em>, <em class="sig-param">timestamp=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">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>
|
||||
@ -539,7 +539,7 @@ was added in vSphere API 6.7.</p></li>
|
||||
|
||||
<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>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">spec</em>, <em class="sig-param">system_name</em>, <em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
@ -573,7 +573,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.Archive.list">
|
||||
<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>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">loc_spec</em>, <em class="sig-param">system_name</em>, <em class="sig-param">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>
|
||||
@ -610,7 +610,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup.system_name_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup.system_name_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.appliance.recovery package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
<title>com.vmware.appliance.recovery package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -195,7 +195,7 @@
|
||||
<span id="com-vmware-appliance-recovery-backup-client-module"></span><h2>com.vmware.appliance.recovery.backup_client module<a class="headerlink" href="#module-com.vmware.appliance.recovery.backup_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="descname">Job</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="sig-name descname">Job</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job" 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">Job</span></code> class provides methods to be performed on a backup job.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -205,7 +205,7 @@
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus">
|
||||
<em class="property">class </em><code class="descname">BackupJobStatus</code><span class="sig-paren">(</span><em>id=None</em>, <em>state=None</em>, <em>messages=None</em>, <em>progress=None</em>, <em>start_time=None</em>, <em>end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">BackupJobStatus</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">messages=None</em>, <em class="sig-param">progress=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus" 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">Job.BackupJobStatus</span></code> class represents the status of a backup/restore
|
||||
job.</p>
|
||||
@ -231,7 +231,7 @@ If None end time is None until backup is finished.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRequest">
|
||||
<em class="property">class </em><code class="descname">BackupRequest</code><span class="sig-paren">(</span><em>parts=None</em>, <em>backup_password=None</em>, <em>location_type=None</em>, <em>location=None</em>, <em>location_user=None</em>, <em>location_password=None</em>, <em>comment=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">BackupRequest</code><span class="sig-paren">(</span><em class="sig-param">parts=None</em>, <em class="sig-param">backup_password=None</em>, <em class="sig-param">location_type=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">location_password=None</em>, <em class="sig-param">comment=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRequest" 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">Job.BackupRequest</span></code> class represents a requested backup piece.</p>
|
||||
<div class="admonition tip">
|
||||
@ -267,7 +267,7 @@ If None comment will be empty.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState">
|
||||
<em class="property">class </em><code class="descname">BackupRestoreProcessState</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">BackupRestoreProcessState</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState" 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">Job.BackupRestoreProcessState</span></code> class defines the possible states of
|
||||
a backup/restore process.</p>
|
||||
@ -288,25 +288,25 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.FAILED">
|
||||
<code class="descname">FAILED</code><em class="property"> = BackupRestoreProcessState(string='FAILED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.FAILED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FAILED</code><em class="property"> = BackupRestoreProcessState(string='FAILED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.FAILED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Backup/Restore job failed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.INPROGRESS">
|
||||
<code class="descname">INPROGRESS</code><em class="property"> = BackupRestoreProcessState(string='INPROGRESS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.INPROGRESS" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">INPROGRESS</code><em class="property"> = BackupRestoreProcessState(string='INPROGRESS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.INPROGRESS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Backup/Restore job is in progress.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.NONE">
|
||||
<code class="descname">NONE</code><em class="property"> = BackupRestoreProcessState(string='NONE')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NONE</code><em class="property"> = BackupRestoreProcessState(string='NONE')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Backup/Restore job is not started.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.SUCCEEDED">
|
||||
<code class="descname">SUCCEEDED</code><em class="property"> = BackupRestoreProcessState(string='SUCCEEDED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.SUCCEEDED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SUCCEEDED</code><em class="property"> = BackupRestoreProcessState(string='SUCCEEDED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.SUCCEEDED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Backup/Restore job completed successfully.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -314,7 +314,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage">
|
||||
<em class="property">class </em><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.appliance.recovery.backup_client.Job.LocalizableMessage" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">LocalizableMessage</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">default_message=None</em>, <em class="sig-param">args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.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">Job.LocalizableMessage</span></code> class represents a localizable message.</p>
|
||||
<div class="admonition tip">
|
||||
@ -335,7 +335,7 @@ names.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType">
|
||||
<em class="property">class </em><code class="descname">LocationType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">LocationType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType" 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">Job.LocationType</span></code> class defines the type of destination location for
|
||||
backup/restore. You specify the location type when you create a backup job.
|
||||
@ -357,50 +357,50 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.FTP">
|
||||
<code class="descname">FTP</code><em class="property"> = LocationType(string='FTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.FTP" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FTP</code><em class="property"> = LocationType(string='FTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.FTP" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is FTP server.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.FTPS">
|
||||
<code class="descname">FTPS</code><em class="property"> = LocationType(string='FTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.FTPS" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FTPS</code><em class="property"> = LocationType(string='FTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.FTPS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is FTPS server.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.HTTP">
|
||||
<code class="descname">HTTP</code><em class="property"> = LocationType(string='HTTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.HTTP" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">HTTP</code><em class="property"> = LocationType(string='HTTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.HTTP" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is HTTP server.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.HTTPS">
|
||||
<code class="descname">HTTPS</code><em class="property"> = LocationType(string='HTTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.HTTPS" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">HTTPS</code><em class="property"> = LocationType(string='HTTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.HTTPS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is HTTPS server.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.NFS">
|
||||
<code class="descname">NFS</code><em class="property"> = LocationType(string='NFS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.NFS" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NFS</code><em class="property"> = LocationType(string='NFS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.NFS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is NFS server. This class attribute was added in vSphere API
|
||||
6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.SCP">
|
||||
<code class="descname">SCP</code><em class="property"> = LocationType(string='SCP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.SCP" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SCP</code><em class="property"> = LocationType(string='SCP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.SCP" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is SSH server.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.SFTP">
|
||||
<code class="descname">SFTP</code><em class="property"> = LocationType(string='SFTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.SFTP" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SFTP</code><em class="property"> = LocationType(string='SFTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.SFTP" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is SFTP server.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.SMB">
|
||||
<code class="descname">SMB</code><em class="property"> = LocationType(string='SMB')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.SMB" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SMB</code><em class="property"> = LocationType(string='SMB')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.SMB" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is SMB server. This class attribute was added in vSphere API
|
||||
6.7.2.</p>
|
||||
</dd></dl>
|
||||
@ -409,7 +409,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnResult">
|
||||
<em class="property">class </em><code class="descname">ReturnResult</code><span class="sig-paren">(</span><em>status=None</em>, <em>messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnResult" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">ReturnResult</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnResult" 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">Job.ReturnResult</span></code> class contains the result information for the
|
||||
cancel operation.</p>
|
||||
@ -430,7 +430,7 @@ names.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus">
|
||||
<em class="property">class </em><code class="descname">ReturnStatus</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">ReturnStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus" 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">Job.ReturnStatus</span></code> class defines the return type for the cancel
|
||||
operation. You specify the return status when you return the result of
|
||||
@ -452,19 +452,19 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.FAIL">
|
||||
<code class="descname">FAIL</code><em class="property"> = ReturnStatus(string='FAIL')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.FAIL" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FAIL</code><em class="property"> = ReturnStatus(string='FAIL')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.FAIL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cancel operation failed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.OK">
|
||||
<code class="descname">OK</code><em class="property"> = ReturnStatus(string='OK')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.OK" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">OK</code><em class="property"> = ReturnStatus(string='OK')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.OK" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cancel operation succeeded.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.WARNING">
|
||||
<code class="descname">WARNING</code><em class="property"> = ReturnStatus(string='WARNING')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.WARNING" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">WARNING</code><em class="property"> = ReturnStatus(string='WARNING')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.WARNING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cancel operation passed with warnings.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -472,7 +472,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.cancel">
|
||||
<code class="descname">cancel</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.cancel" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">cancel</code><span class="sig-paren">(</span><em class="sig-param">id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.cancel" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cancel the backup job.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -499,7 +499,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>piece</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">piece</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initiate backup.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -524,7 +524,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>See backup job progress/result.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -551,7 +551,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Job.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get list of backup jobs</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
@ -573,7 +573,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.LocationSpec">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="descname">LocationSpec</code><span class="sig-paren">(</span><em>location=None</em>, <em>location_user=None</em>, <em>location_password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.LocationSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="sig-name descname">LocationSpec</code><span class="sig-paren">(</span><em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">location_password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.LocationSpec" 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">LocationSpec</span></code> class has fields to represent a location on the backup
|
||||
server. This class was added in vSphere API 6.7.</p>
|
||||
@ -599,7 +599,7 @@ If None authentication will not be used.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Parts">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="descname">Parts</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="sig-name descname">Parts</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts" 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><code class="docutils literal notranslate"><span class="pre">Parts</span></code> class provides methods Provides list of parts optional for the
|
||||
backup</p>
|
||||
@ -610,7 +610,7 @@ backup</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage">
|
||||
<em class="property">class </em><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.appliance.recovery.backup_client.Parts.LocalizableMessage" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">LocalizableMessage</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">default_message=None</em>, <em class="sig-param">args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.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><code class="docutils literal notranslate"><span class="pre">Parts.LocalizableMessage</span></code> class Structure representing message</p>
|
||||
<div class="admonition tip">
|
||||
@ -631,7 +631,7 @@ names.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Parts.Part">
|
||||
<em class="property">class </em><code class="descname">Part</code><span class="sig-paren">(</span><em>id=None</em>, <em>name=None</em>, <em>description=None</em>, <em>selected_by_default=None</em>, <em>optional=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.Part" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Part</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">selected_by_default=None</em>, <em class="sig-param">optional=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.Part" 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><code class="docutils literal notranslate"><span class="pre">Parts.Part</span></code> class Structure representing backup restore part</p>
|
||||
<div class="admonition tip">
|
||||
@ -660,7 +660,7 @@ identifier for the resource type:
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Parts.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets the size (in MB) of the part.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -683,7 +683,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Parts.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets a list of the backup parts.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
@ -703,7 +703,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="descname">Schedules</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="sig-name descname">Schedules</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules" 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">Schedules</span></code> class provides methods to be performed to manage backup
|
||||
schedules. This class was added in vSphere API 6.7.</p>
|
||||
@ -714,7 +714,7 @@ schedules. This class was added in vSphere API 6.7.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.CreateSpec">
|
||||
<em class="property">class </em><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>parts=None</em>, <em>backup_password=None</em>, <em>location=None</em>, <em>location_user=None</em>, <em>location_password=None</em>, <em>enable=None</em>, <em>recurrence_info=None</em>, <em>retention_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">parts=None</em>, <em class="sig-param">backup_password=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">location_password=None</em>, <em class="sig-param">enable=None</em>, <em class="sig-param">recurrence_info=None</em>, <em class="sig-param">retention_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.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">Schedules.CreateSpec</span></code> class contains fields to be specified for
|
||||
creating a new schedule. The structure includes parts, location
|
||||
@ -766,7 +766,7 @@ If None all the completed backup jobs will be retained forever. See
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek">
|
||||
<em class="property">class </em><code class="descname">DayOfWeek</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">DayOfWeek</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek" 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">Schedules.DayOfWeek</span></code> class defines the set of days when backup can
|
||||
be scheduled. The days can be specified as a list of individual days. You
|
||||
@ -790,43 +790,43 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.FRIDAY">
|
||||
<code class="descname">FRIDAY</code><em class="property"> = DayOfWeek(string='FRIDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.FRIDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FRIDAY</code><em class="property"> = DayOfWeek(string='FRIDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.FRIDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Friday. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.MONDAY">
|
||||
<code class="descname">MONDAY</code><em class="property"> = DayOfWeek(string='MONDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.MONDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">MONDAY</code><em class="property"> = DayOfWeek(string='MONDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.MONDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Monday. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.SATURDAY">
|
||||
<code class="descname">SATURDAY</code><em class="property"> = DayOfWeek(string='SATURDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.SATURDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SATURDAY</code><em class="property"> = DayOfWeek(string='SATURDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.SATURDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Saturday. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.SUNDAY">
|
||||
<code class="descname">SUNDAY</code><em class="property"> = DayOfWeek(string='SUNDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.SUNDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SUNDAY</code><em class="property"> = DayOfWeek(string='SUNDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.SUNDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sunday. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.THURSDAY">
|
||||
<code class="descname">THURSDAY</code><em class="property"> = DayOfWeek(string='THURSDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.THURSDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">THURSDAY</code><em class="property"> = DayOfWeek(string='THURSDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.THURSDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Thursday. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.TUESDAY">
|
||||
<code class="descname">TUESDAY</code><em class="property"> = DayOfWeek(string='TUESDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.TUESDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">TUESDAY</code><em class="property"> = DayOfWeek(string='TUESDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.TUESDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tuesday. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.WEDNESDAY">
|
||||
<code class="descname">WEDNESDAY</code><em class="property"> = DayOfWeek(string='WEDNESDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.WEDNESDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">WEDNESDAY</code><em class="property"> = DayOfWeek(string='WEDNESDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.WEDNESDAY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Wednesday. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -834,7 +834,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>parts=None</em>, <em>location=None</em>, <em>location_user=None</em>, <em>enable=None</em>, <em>recurrence_info=None</em>, <em>retention_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">parts=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">enable=None</em>, <em class="sig-param">recurrence_info=None</em>, <em class="sig-param">retention_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.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">Schedules.Info</span></code> class contains information about an existing
|
||||
schedule. The structure includes Schedule ID, parts, location information,
|
||||
@ -874,7 +874,7 @@ If None all the completed backup jobs are retained forever. See
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo">
|
||||
<em class="property">class </em><code class="descname">RecurrenceInfo</code><span class="sig-paren">(</span><em>minute=None</em>, <em>hour=None</em>, <em>days=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">RecurrenceInfo</code><span class="sig-paren">(</span><em class="sig-param">minute=None</em>, <em class="sig-param">hour=None</em>, <em class="sig-param">days=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo" 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">Schedules.RecurrenceInfo</span></code> class contains the recurrence information
|
||||
associated with a schedule. This class was added in vSphere API 6.7.</p>
|
||||
@ -900,7 +900,7 @@ If None the backup will be run everyday.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo">
|
||||
<em class="property">class </em><code class="descname">RetentionInfo</code><span class="sig-paren">(</span><em>max_count=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">RetentionInfo</code><span class="sig-paren">(</span><em class="sig-param">max_count=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo" 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">Schedules.RetentionInfo</span></code> class contains retention information
|
||||
associated with a schedule. This class was added in vSphere API 6.7.</p>
|
||||
@ -920,7 +920,7 @@ added in vSphere API 6.7.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.UpdateSpec">
|
||||
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>parts=None</em>, <em>backup_password=None</em>, <em>location=None</em>, <em>location_user=None</em>, <em>location_password=None</em>, <em>enable=None</em>, <em>recurrence_info=None</em>, <em>retention_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">parts=None</em>, <em class="sig-param">backup_password=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">location_password=None</em>, <em class="sig-param">enable=None</em>, <em class="sig-param">recurrence_info=None</em>, <em class="sig-param">retention_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.UpdateSpec" 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">Schedules.UpdateSpec</span></code> class contains the fields of the existing
|
||||
schedule which can be updated. This class was added in vSphere API 6.7.</p>
|
||||
@ -971,7 +971,7 @@ If None the information will not be changed. See
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>schedule</em>, <em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">schedule</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a schedule. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -999,7 +999,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>schedule</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">schedule</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes an existing schedule. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -1020,7 +1020,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>schedule</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">schedule</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns an existing schedule information based on id. This method was
|
||||
added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -1048,7 +1048,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a list of existing schedules with details. This method was
|
||||
added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -1070,7 +1070,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.run">
|
||||
<code class="descname">run</code><span class="sig-paren">(</span><em>schedule</em>, <em>comment=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.run" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">run</code><span class="sig-paren">(</span><em class="sig-param">schedule</em>, <em class="sig-param">comment=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initiate backup with the specified schedule. This method was added in
|
||||
vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -1106,7 +1106,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>schedule</em>, <em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.update" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">schedule</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Updates a schedule. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -1136,7 +1136,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.backup_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_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_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">
|
||||
@ -1148,7 +1148,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.SystemName">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="descname">SystemName</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.SystemName" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="sig-name descname">SystemName</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.SystemName" 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">SystemName</span></code> class provides methods to enumerate system names of
|
||||
appliance backups. This class was added in vSphere API 6.7.</p>
|
||||
@ -1159,7 +1159,7 @@ appliance backups. This class was added in vSphere API 6.7.</p>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.backup_client.SystemName.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>loc_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.SystemName.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">loc_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.SystemName.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a list of system names for which backup archives exist under
|
||||
<code class="docutils literal notranslate"><span class="pre">loc_spec</span></code>. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -1193,7 +1193,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
<span id="com-vmware-appliance-recovery-reconciliation-client-module"></span><h2>com.vmware.appliance.recovery.reconciliation_client module<a class="headerlink" href="#module-com.vmware.appliance.recovery.reconciliation_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.reconciliation_client.</code><code class="descname">Job</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.reconciliation_client.</code><code class="sig-name descname">Job</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job" 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">Job</span></code> class provides methods to create and get the status of
|
||||
reconciliation job. This class was added in vSphere API 6.7.</p>
|
||||
@ -1204,7 +1204,7 @@ reconciliation job. This class was added in vSphere API 6.7.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.CreateSpec">
|
||||
<em class="property">class </em><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>sso_admin_user_name=None</em>, <em>sso_admin_user_password=None</em>, <em>ignore_warnings=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">sso_admin_user_name=None</em>, <em class="sig-param">sso_admin_user_password=None</em>, <em class="sig-param">ignore_warnings=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.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">Job.CreateSpec</span></code> class has the fields to request the start of
|
||||
reconciliation job. This class was added in vSphere API 6.7.</p>
|
||||
@ -1237,7 +1237,7 @@ operation.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><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>messages=None</em>, <em>progress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">description=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">operation=None</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">target=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">cancelable=None</em>, <em class="sig-param">error=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">messages=None</em>, <em class="sig-param">progress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.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">Job.Info</span></code> class represents the reconciliation job information. It
|
||||
contains information related to current Status, any associated messages and
|
||||
@ -1306,7 +1306,7 @@ in vSphere API 6.7.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.Status">
|
||||
<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.appliance.recovery.reconciliation_client.Job.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.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>The <code class="docutils literal notranslate"><span class="pre">Job.Status</span></code> class defines the status values that can be reported for
|
||||
an operation. This enumeration was added in vSphere API 6.7.</p>
|
||||
@ -1327,27 +1327,27 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.Status.FAILED">
|
||||
<code class="descname">FAILED</code><em class="property"> = Status(string='FAILED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.FAILED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FAILED</code><em class="property"> = Status(string='FAILED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.FAILED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The operation failed. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.Status.NONE">
|
||||
<code class="descname">NONE</code><em class="property"> = Status(string='NONE')</em><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NONE</code><em class="property"> = Status(string='NONE')</em><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The operation is not running. This class attribute was added in vSphere API
|
||||
6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.Status.RUNNING">
|
||||
<code class="descname">RUNNING</code><em class="property"> = Status(string='RUNNING')</em><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.RUNNING" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RUNNING</code><em class="property"> = Status(string='RUNNING')</em><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.RUNNING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The operation is in progress. This class attribute was added in vSphere API
|
||||
6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.Status.SUCCEEDED">
|
||||
<code class="descname">SUCCEEDED</code><em class="property"> = Status(string='SUCCEEDED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.SUCCEEDED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SUCCEEDED</code><em class="property"> = Status(string='SUCCEEDED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.SUCCEEDED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The operation completed successfully. This class attribute was added in
|
||||
vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
@ -1356,7 +1356,7 @@ vSphere API 6.7.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.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.appliance.recovery.reconciliation_client.Job.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initiate reconciliation. This method was added in vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -1386,7 +1386,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get reconciliation job progress/result. This method was added in
|
||||
vSphere API 6.7.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -1411,7 +1411,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.reconciliation_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.reconciliation_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.reconciliation_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.reconciliation_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_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">
|
||||
@ -1426,7 +1426,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
<span id="com-vmware-appliance-recovery-restore-client-module"></span><h2>com.vmware.appliance.recovery.restore_client module<a class="headerlink" href="#module-com.vmware.appliance.recovery.restore_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.restore_client.</code><code class="descname">Job</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.restore_client.</code><code class="sig-name descname">Job</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job" 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><code class="docutils literal notranslate"><span class="pre">Job</span></code> class provides methods Performs restore operations</p>
|
||||
<dl class="field-list simple">
|
||||
@ -1436,7 +1436,7 @@ if any error occurs during the execution of the operation.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState">
|
||||
<em class="property">class </em><code class="descname">BackupRestoreProcessState</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">BackupRestoreProcessState</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState" 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><code class="docutils literal notranslate"><span class="pre">Job.BackupRestoreProcessState</span></code> class Defines state of backup/restore
|
||||
process</p>
|
||||
@ -1457,25 +1457,25 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.FAILED">
|
||||
<code class="descname">FAILED</code><em class="property"> = BackupRestoreProcessState(string='FAILED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.FAILED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FAILED</code><em class="property"> = BackupRestoreProcessState(string='FAILED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.FAILED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Failed</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.INPROGRESS">
|
||||
<code class="descname">INPROGRESS</code><em class="property"> = BackupRestoreProcessState(string='INPROGRESS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.INPROGRESS" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">INPROGRESS</code><em class="property"> = BackupRestoreProcessState(string='INPROGRESS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.INPROGRESS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>In progress</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.NONE">
|
||||
<code class="descname">NONE</code><em class="property"> = BackupRestoreProcessState(string='NONE')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NONE</code><em class="property"> = BackupRestoreProcessState(string='NONE')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Not started</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.SUCCEEDED">
|
||||
<code class="descname">SUCCEEDED</code><em class="property"> = BackupRestoreProcessState(string='SUCCEEDED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.SUCCEEDED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SUCCEEDED</code><em class="property"> = BackupRestoreProcessState(string='SUCCEEDED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.SUCCEEDED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Completed successfully</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -1483,7 +1483,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage">
|
||||
<em class="property">class </em><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.appliance.recovery.restore_client.Job.LocalizableMessage" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">LocalizableMessage</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">default_message=None</em>, <em class="sig-param">args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.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><code class="docutils literal notranslate"><span class="pre">Job.LocalizableMessage</span></code> class Structure representing message</p>
|
||||
<div class="admonition tip">
|
||||
@ -1504,7 +1504,7 @@ names.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType">
|
||||
<em class="property">class </em><code class="descname">LocationType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">LocationType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType" 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><code class="docutils literal notranslate"><span class="pre">Job.LocationType</span></code> class Defines type of all locations for backup/restore</p>
|
||||
<div class="admonition note">
|
||||
@ -1524,50 +1524,50 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.FTP">
|
||||
<code class="descname">FTP</code><em class="property"> = LocationType(string='FTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.FTP" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FTP</code><em class="property"> = LocationType(string='FTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.FTP" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is FTP server</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.FTPS">
|
||||
<code class="descname">FTPS</code><em class="property"> = LocationType(string='FTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.FTPS" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FTPS</code><em class="property"> = LocationType(string='FTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.FTPS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is FTPS server</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.HTTP">
|
||||
<code class="descname">HTTP</code><em class="property"> = LocationType(string='HTTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.HTTP" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">HTTP</code><em class="property"> = LocationType(string='HTTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.HTTP" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is HTTP server</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.HTTPS">
|
||||
<code class="descname">HTTPS</code><em class="property"> = LocationType(string='HTTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.HTTPS" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">HTTPS</code><em class="property"> = LocationType(string='HTTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.HTTPS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is HTTPS server</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.NFS">
|
||||
<code class="descname">NFS</code><em class="property"> = LocationType(string='NFS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.NFS" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NFS</code><em class="property"> = LocationType(string='NFS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.NFS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is NFS server. This class attribute was added in vSphere API
|
||||
6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.SCP">
|
||||
<code class="descname">SCP</code><em class="property"> = LocationType(string='SCP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.SCP" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SCP</code><em class="property"> = LocationType(string='SCP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.SCP" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is SSH server</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.SFTP">
|
||||
<code class="descname">SFTP</code><em class="property"> = LocationType(string='SFTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.SFTP" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SFTP</code><em class="property"> = LocationType(string='SFTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.SFTP" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is SFTP server</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.SMB">
|
||||
<code class="descname">SMB</code><em class="property"> = LocationType(string='SMB')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.SMB" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SMB</code><em class="property"> = LocationType(string='SMB')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.SMB" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destination is SMB server. This class attribute was added in vSphere API
|
||||
6.7.2.</p>
|
||||
</dd></dl>
|
||||
@ -1576,7 +1576,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus">
|
||||
<em class="property">class </em><code class="descname">RestoreJobStatus</code><span class="sig-paren">(</span><em>state=None</em>, <em>messages=None</em>, <em>progress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">RestoreJobStatus</code><span class="sig-paren">(</span><em class="sig-param">state=None</em>, <em class="sig-param">messages=None</em>, <em class="sig-param">progress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus" 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><code class="docutils literal notranslate"><span class="pre">Job.RestoreJobStatus</span></code> class Structure representing backup restore status</p>
|
||||
<div class="admonition tip">
|
||||
@ -1597,7 +1597,7 @@ names.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.RestoreRequest">
|
||||
<em class="property">class </em><code class="descname">RestoreRequest</code><span class="sig-paren">(</span><em>backup_password=None</em>, <em>location_type=None</em>, <em>location=None</em>, <em>location_user=None</em>, <em>location_password=None</em>, <em>sso_admin_user_name=None</em>, <em>sso_admin_user_password=None</em>, <em>ignore_warnings=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">RestoreRequest</code><span class="sig-paren">(</span><em class="sig-param">backup_password=None</em>, <em class="sig-param">location_type=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">location_password=None</em>, <em class="sig-param">sso_admin_user_name=None</em>, <em class="sig-param">sso_admin_user_password=None</em>, <em class="sig-param">ignore_warnings=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreRequest" 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><code class="docutils literal notranslate"><span class="pre">Job.RestoreRequest</span></code> class Structure representing requested restore piece</p>
|
||||
<div class="admonition tip">
|
||||
@ -1637,7 +1637,7 @@ If None, validation warnings will fail the restore operation</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnResult">
|
||||
<em class="property">class </em><code class="descname">ReturnResult</code><span class="sig-paren">(</span><em>status=None</em>, <em>messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnResult" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">ReturnResult</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnResult" 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><code class="docutils literal notranslate"><span class="pre">Job.ReturnResult</span></code> class Structure representing precheck result</p>
|
||||
<div class="admonition tip">
|
||||
@ -1657,7 +1657,7 @@ names.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnStatus">
|
||||
<em class="property">class </em><code class="descname">ReturnStatus</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">ReturnStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus" 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><code class="docutils literal notranslate"><span class="pre">Job.ReturnStatus</span></code> class Defines the state of precheck</p>
|
||||
<div class="admonition note">
|
||||
@ -1677,19 +1677,19 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.FAIL">
|
||||
<code class="descname">FAIL</code><em class="property"> = ReturnStatus(string='FAIL')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.FAIL" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FAIL</code><em class="property"> = ReturnStatus(string='FAIL')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.FAIL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check failed</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.OK">
|
||||
<code class="descname">OK</code><em class="property"> = ReturnStatus(string='OK')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.OK" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">OK</code><em class="property"> = ReturnStatus(string='OK')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.OK" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check passed</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.WARNING">
|
||||
<code class="descname">WARNING</code><em class="property"> = ReturnStatus(string='WARNING')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.WARNING" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">WARNING</code><em class="property"> = ReturnStatus(string='WARNING')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.WARNING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Passed with warnings</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -1697,7 +1697,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.cancel">
|
||||
<code class="descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.cancel" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.cancel" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cancel the restore job</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
@ -1715,7 +1715,7 @@ Generic error</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>piece</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">piece</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initiate restore.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -1744,7 +1744,7 @@ Generic error</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.Job.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>See restore job progress/result.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
@ -1764,7 +1764,7 @@ Generic error</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.recovery.restore_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.appliance.recovery.restore_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.restore_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.restore_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_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">
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.appliance.system package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -182,7 +182,7 @@
|
||||
<span id="com-vmware-appliance-system-time-client-module"></span><h2>com.vmware.appliance.system.time_client module<a class="headerlink" href="#module-com.vmware.appliance.system.time_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.system.time_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.system.time_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
@ -194,7 +194,7 @@
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.appliance.system.time_client.Timezone">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.system.time_client.</code><code class="sig-name descname">Timezone</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -205,7 +205,7 @@ timezone. This class was added in vSphere API 6.7.</p>
|
||||
</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>
|
||||
<code class="sig-name 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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
@ -223,7 +223,7 @@ if timezone cannot be read.</p>
|
||||
|
||||
<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>
|
||||
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.cis package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
<title>com.vmware.cis package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -185,7 +185,7 @@ tags and their categories (the group a tag belongs to). You can also query the
|
||||
attached tags and attached objects.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.Category">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.cis.tagging_client.</code><code class="descname">Category</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis.tagging_client.</code><code class="sig-name descname">Category</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category" 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">Category</span></code> class provides methods to create, read, update, delete,
|
||||
and enumerate categories.</p>
|
||||
@ -196,7 +196,7 @@ and enumerate categories.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.Category.CreateSpec">
|
||||
<em class="property">class </em><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>name=None</em>, <em>description=None</em>, <em>cardinality=None</em>, <em>associable_types=None</em>, <em>category_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">cardinality=None</em>, <em class="sig-param">associable_types=None</em>, <em class="sig-param">category_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.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">Category.CreateSpec</span></code> class is used to create a category.</p>
|
||||
<p>Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.create" title="com.vmware.cis.tagging_client.Category.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Category.create()</span></code></a> method to create a category defined by the
|
||||
@ -227,7 +227,7 @@ If None an identifier will be generated by the server</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.Category.UpdateSpec">
|
||||
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>name=None</em>, <em>description=None</em>, <em>cardinality=None</em>, <em>associable_types=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">cardinality=None</em>, <em class="sig-param">associable_types=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.UpdateSpec" 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">Category.UpdateSpec</span></code> class describes the updates to be made to an
|
||||
existing category.</p>
|
||||
@ -270,7 +270,7 @@ If None the associable types will not be modified.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Category.add_to_used_by">
|
||||
<code class="descname">add_to_used_by</code><span class="sig-paren">(</span><em>category_id</em>, <em>used_by_entity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.add_to_used_by" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">add_to_used_by</code><span class="sig-paren">(</span><em class="sig-param">category_id</em>, <em class="sig-param">used_by_entity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.add_to_used_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> to the <code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.used_by</span></code>
|
||||
subscribers <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> for the specified category. If the
|
||||
<code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> is already in the <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, then this becomes an
|
||||
@ -301,7 +301,7 @@ if you do not have the privilege to add an entity to the
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Category.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>create_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">create_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a category. To invoke this method, you need the create category
|
||||
privilege.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -334,7 +334,7 @@ if you do not have the privilege to create a category.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Category.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>category_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">category_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes an existing category. To invoke this method, you need the
|
||||
delete privilege on the category.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -361,7 +361,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Category.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>category_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">category_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fetches the category information for the given category identifier. In
|
||||
order to view the category information, you need the read privilege on
|
||||
the category.</p>
|
||||
@ -391,7 +391,7 @@ if you do not have the privilege to read the category.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Category.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enumerates the categories in the system. To invoke this method, you
|
||||
need the read privilege on the individual categories. The <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>
|
||||
will only contain those categories for which you have read privileges.</p>
|
||||
@ -410,7 +410,7 @@ The return value will contain identifiers for the resource type:
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Category.list_used_categories">
|
||||
<code class="descname">list_used_categories</code><span class="sig-paren">(</span><em>used_by_entity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.list_used_categories" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list_used_categories</code><span class="sig-paren">(</span><em class="sig-param">used_by_entity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.list_used_categories" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enumerates all categories for which the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> is part of
|
||||
the <code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.used_by</span></code> subscribers <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>. To invoke
|
||||
this method, you need the read privilege on the individual categories.</p>
|
||||
@ -432,7 +432,7 @@ The return value will contain identifiers for the resource type:
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Category.remove_from_used_by">
|
||||
<code class="descname">remove_from_used_by</code><span class="sig-paren">(</span><em>category_id</em>, <em>used_by_entity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.remove_from_used_by" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">remove_from_used_by</code><span class="sig-paren">(</span><em class="sig-param">category_id</em>, <em class="sig-param">used_by_entity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.remove_from_used_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Removes the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> from the <code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.used_by</span></code>
|
||||
subscribers <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>. If the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> is not using this
|
||||
category, then this becomes a no-op. To invoke this method, you need
|
||||
@ -462,7 +462,7 @@ if you do not have the privilege to remove an entity from the
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Category.revoke_propagating_permissions">
|
||||
<code class="descname">revoke_propagating_permissions</code><span class="sig-paren">(</span><em>category_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.revoke_propagating_permissions" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">revoke_propagating_permissions</code><span class="sig-paren">(</span><em class="sig-param">category_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.revoke_propagating_permissions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Revokes all propagating permissions on the given category. You should
|
||||
then attach a direct permission with tagging privileges on the given
|
||||
category. To invoke this method, you need category related privileges
|
||||
@ -488,7 +488,7 @@ on the category.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Category.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>category_id</em>, <em>update_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.update" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">category_id</em>, <em class="sig-param">update_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Updates an existing category. To invoke this method, you need the edit
|
||||
privilege on the category.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -525,7 +525,7 @@ if you do not have the privilege to update the category.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.CategoryModel">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.cis.tagging_client.</code><code class="descname">CategoryModel</code><span class="sig-paren">(</span><em>id=None</em>, <em>name=None</em>, <em>description=None</em>, <em>cardinality=None</em>, <em>associable_types=None</em>, <em>used_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis.tagging_client.</code><code class="sig-name descname">CategoryModel</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">cardinality=None</em>, <em class="sig-param">associable_types=None</em>, <em class="sig-param">used_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel" 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">CategoryModel</span></code> class defines a category that is used to group one or
|
||||
more tags.</p>
|
||||
@ -562,7 +562,7 @@ subscription from this <code class="xref py py-class docutils literal notranslat
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.CategoryModel.Cardinality">
|
||||
<em class="property">class </em><code class="descname">Cardinality</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Cardinality</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality" 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">CategoryModel.Cardinality</span></code> class defines the number of tags in a
|
||||
category that can be assigned to an object.</p>
|
||||
@ -583,7 +583,7 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.cis.tagging_client.CategoryModel.Cardinality.MULTIPLE">
|
||||
<code class="descname">MULTIPLE</code><em class="property"> = Cardinality(string='MULTIPLE')</em><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality.MULTIPLE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">MULTIPLE</code><em class="property"> = Cardinality(string='MULTIPLE')</em><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality.MULTIPLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>An object can be assigned several of the tags in this category. For
|
||||
example, if a category is “Server”, then different tags of this category
|
||||
would be “AppServer”, “DatabaseServer” and so on. In this case a VM object
|
||||
@ -593,7 +593,7 @@ of the associated category here is multiple.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.cis.tagging_client.CategoryModel.Cardinality.SINGLE">
|
||||
<code class="descname">SINGLE</code><em class="property"> = Cardinality(string='SINGLE')</em><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality.SINGLE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SINGLE</code><em class="property"> = Cardinality(string='SINGLE')</em><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality.SINGLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>An object can only be assigned one of the tags in this category. For
|
||||
example, if a category is “Operating System”, then different tags of this
|
||||
category would be “Windows”, “Linux”, and so on. In this case a VM object
|
||||
@ -607,7 +607,7 @@ associated category here is single.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.cis.tagging_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.cis.tagging_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis.tagging_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_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">
|
||||
@ -619,7 +619,7 @@ associated category here is single.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.cis.tagging_client.</code><code class="descname">Tag</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis.tagging_client.</code><code class="sig-name descname">Tag</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag" 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">Tag</span></code> class provides methods to create, read, update, delete, and
|
||||
enumerate tags.</p>
|
||||
@ -630,7 +630,7 @@ enumerate tags.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag.CreateSpec">
|
||||
<em class="property">class </em><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>name=None</em>, <em>description=None</em>, <em>category_id=None</em>, <em>tag_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">category_id=None</em>, <em class="sig-param">tag_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.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">Tag.CreateSpec</span></code> class describes a tag.</p>
|
||||
<p>Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.create" title="com.vmware.cis.tagging_client.Tag.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tag.create()</span></code></a> method to create a tag defined by the create
|
||||
@ -667,7 +667,7 @@ If None an identifier will be generated by the server</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag.UpdateSpec">
|
||||
<em class="property">class </em><code class="descname">UpdateSpec</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.cis.tagging_client.Tag.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.UpdateSpec" 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">Tag.UpdateSpec</span></code> class describes the updates to be made to an
|
||||
existing tag.</p>
|
||||
@ -694,7 +694,7 @@ If None the description will not be modified.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag.add_to_used_by">
|
||||
<code class="descname">add_to_used_by</code><span class="sig-paren">(</span><em>tag_id</em>, <em>used_by_entity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.add_to_used_by" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">add_to_used_by</code><span class="sig-paren">(</span><em class="sig-param">tag_id</em>, <em class="sig-param">used_by_entity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.add_to_used_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> to the <code class="xref py py-attr docutils literal notranslate"><span class="pre">TagModel.used_by</span></code> subscribers
|
||||
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>. If the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> is already in the <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>,
|
||||
then this becomes a no-op. To invoke this method, you need the modify
|
||||
@ -723,7 +723,7 @@ if you do not have the privilege to add an entity to the
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>create_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">create_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a tag. To invoke this method, you need the create tag privilege
|
||||
on the input category.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -761,7 +761,7 @@ if you do not have the privilege to create tag.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>tag_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tag_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes an existing tag. To invoke this method, you need the delete
|
||||
privilege on the tag.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -787,7 +787,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>tag_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tag_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fetches the tag information for the given tag identifier. To invoke
|
||||
this method, you need the read privilege on the tag in order to view
|
||||
the tag info.</p>
|
||||
@ -816,7 +816,7 @@ if the user does not have the privilege to read the tag.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enumerates the tags in the system. To invoke this method, you need read
|
||||
privilege on the individual tags. The <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> will only contain
|
||||
tags for which you have read privileges.</p>
|
||||
@ -835,7 +835,7 @@ The return value will contain identifiers for the resource type:
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag.list_tags_for_category">
|
||||
<code class="descname">list_tags_for_category</code><span class="sig-paren">(</span><em>category_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.list_tags_for_category" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list_tags_for_category</code><span class="sig-paren">(</span><em class="sig-param">category_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.list_tags_for_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enumerates all tags for the given category. To invoke this method, you
|
||||
need the read privilege on the given category and the individual tags
|
||||
in that category.</p>
|
||||
@ -868,7 +868,7 @@ if you do not have the privilege to read the category.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag.list_used_tags">
|
||||
<code class="descname">list_used_tags</code><span class="sig-paren">(</span><em>used_by_entity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.list_used_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list_used_tags</code><span class="sig-paren">(</span><em class="sig-param">used_by_entity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.list_used_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enumerates all tags for which the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> is part of the
|
||||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagModel.used_by</span></code> subscribers <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>. To invoke this
|
||||
method, you need the read privilege on the individual tags.</p>
|
||||
@ -890,7 +890,7 @@ The return value will contain identifiers for the resource type:
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag.remove_from_used_by">
|
||||
<code class="descname">remove_from_used_by</code><span class="sig-paren">(</span><em>tag_id</em>, <em>used_by_entity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.remove_from_used_by" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">remove_from_used_by</code><span class="sig-paren">(</span><em class="sig-param">tag_id</em>, <em class="sig-param">used_by_entity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.remove_from_used_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Removes the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> from the <code class="xref py py-attr docutils literal notranslate"><span class="pre">TagModel.used_by</span></code>
|
||||
subscribers set. If the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> is not using this tag, then
|
||||
this becomes a no-op. To invoke this method, you need modify
|
||||
@ -919,7 +919,7 @@ if you do not have the privilege to remove an entity from the
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag.revoke_propagating_permissions">
|
||||
<code class="descname">revoke_propagating_permissions</code><span class="sig-paren">(</span><em>tag_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.revoke_propagating_permissions" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">revoke_propagating_permissions</code><span class="sig-paren">(</span><em class="sig-param">tag_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.revoke_propagating_permissions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Revokes all propagating permissions on the given tag. You should then
|
||||
attach a direct permission with tagging privileges on the given tag. To
|
||||
invoke this method, you need tag related privileges (direct or
|
||||
@ -944,7 +944,7 @@ on the tag.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.Tag.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>tag_id</em>, <em>update_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.update" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tag_id</em>, <em class="sig-param">update_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Updates an existing tag. To invoke this method, you need the edit
|
||||
privilege on the tag.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -980,7 +980,7 @@ if you do not have the privilege to update the tag.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.cis.tagging_client.</code><code class="descname">TagAssociation</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis.tagging_client.</code><code class="sig-name descname">TagAssociation</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation" 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">TagAssociation</span></code> class provides methods to attach, detach, and query
|
||||
tags.</p>
|
||||
@ -991,7 +991,7 @@ tags.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.BatchResult">
|
||||
<em class="property">class </em><code class="descname">BatchResult</code><span class="sig-paren">(</span><em>success=None</em>, <em>error_messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">BatchResult</code><span class="sig-paren">(</span><em class="sig-param">success=None</em>, <em class="sig-param">error_messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult" 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">TagAssociation.BatchResult</span></code> class describes the result of performing
|
||||
the same method on several tags or objects in a single invocation. This
|
||||
@ -1016,7 +1016,7 @@ vSphere API 6.5.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.ObjectToTags">
|
||||
<em class="property">class </em><code class="descname">ObjectToTags</code><span class="sig-paren">(</span><em>object_id=None</em>, <em>tag_ids=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.ObjectToTags" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">ObjectToTags</code><span class="sig-paren">(</span><em class="sig-param">object_id=None</em>, <em class="sig-param">tag_ids=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.ObjectToTags" 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">TagAssociation.ObjectToTags</span></code> class describes an object and its
|
||||
related tags. Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects" title="com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects"><code class="xref py py-func docutils literal notranslate"><span class="pre">TagAssociation.list_attached_tags_on_objects()</span></code></a>
|
||||
@ -1046,7 +1046,7 @@ the resource type: <code class="docutils literal notranslate"><span class="pre">
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.TagToObjects">
|
||||
<em class="property">class </em><code class="descname">TagToObjects</code><span class="sig-paren">(</span><em>tag_id=None</em>, <em>object_ids=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.TagToObjects" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">TagToObjects</code><span class="sig-paren">(</span><em class="sig-param">tag_id=None</em>, <em class="sig-param">object_ids=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.TagToObjects" 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">TagAssociation.TagToObjects</span></code> class describes a tag and its related
|
||||
objects. Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags" title="com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags"><code class="xref py py-func docutils literal notranslate"><span class="pre">TagAssociation.list_attached_objects_on_tags()</span></code></a>
|
||||
@ -1077,7 +1077,7 @@ vSphere API 6.5.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.attach">
|
||||
<code class="descname">attach</code><span class="sig-paren">(</span><em>tag_id</em>, <em>object_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.attach" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">attach</code><span class="sig-paren">(</span><em class="sig-param">tag_id</em>, <em class="sig-param">object_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.attach" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attaches the given tag to the input object. The tag needs to meet the
|
||||
cardinality (<code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.cardinality</span></code>) and associability
|
||||
(<code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.associable_types</span></code>) criteria in order to be
|
||||
@ -1117,7 +1117,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.attach_multiple_tags_to_object">
|
||||
<code class="descname">attach_multiple_tags_to_object</code><span class="sig-paren">(</span><em>object_id</em>, <em>tag_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.attach_multiple_tags_to_object" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">attach_multiple_tags_to_object</code><span class="sig-paren">(</span><em class="sig-param">object_id</em>, <em class="sig-param">tag_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.attach_multiple_tags_to_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attaches the given tags to the input object. If a tag is already
|
||||
attached to the object, then the individual method is a no-op and an
|
||||
error will not be added to
|
||||
@ -1154,7 +1154,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.attach_tag_to_multiple_objects">
|
||||
<code class="descname">attach_tag_to_multiple_objects</code><span class="sig-paren">(</span><em>tag_id</em>, <em>object_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.attach_tag_to_multiple_objects" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">attach_tag_to_multiple_objects</code><span class="sig-paren">(</span><em class="sig-param">tag_id</em>, <em class="sig-param">object_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.attach_tag_to_multiple_objects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attaches the given tag to the input objects. If a tag is already
|
||||
attached to the object, then the individual method is a no-op and an
|
||||
error will not be added to
|
||||
@ -1195,7 +1195,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.detach">
|
||||
<code class="descname">detach</code><span class="sig-paren">(</span><em>tag_id</em>, <em>object_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.detach" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">detach</code><span class="sig-paren">(</span><em class="sig-param">tag_id</em>, <em class="sig-param">object_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.detach" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Detaches the tag from the given object. If the tag is already removed
|
||||
from the object, then this method is a no-op and an error will not be
|
||||
thrown. To invoke this method, you need the attach tag privilege on the
|
||||
@ -1227,7 +1227,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.detach_multiple_tags_from_object">
|
||||
<code class="descname">detach_multiple_tags_from_object</code><span class="sig-paren">(</span><em>object_id</em>, <em>tag_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.detach_multiple_tags_from_object" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">detach_multiple_tags_from_object</code><span class="sig-paren">(</span><em class="sig-param">object_id</em>, <em class="sig-param">tag_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.detach_multiple_tags_from_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Detaches the given tags from the input object. If a tag is already
|
||||
removed from the object, then the individual method is a no-op and an
|
||||
error will not be added to
|
||||
@ -1264,7 +1264,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.detach_tag_from_multiple_objects">
|
||||
<code class="descname">detach_tag_from_multiple_objects</code><span class="sig-paren">(</span><em>tag_id</em>, <em>object_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.detach_tag_from_multiple_objects" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">detach_tag_from_multiple_objects</code><span class="sig-paren">(</span><em class="sig-param">tag_id</em>, <em class="sig-param">object_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.detach_tag_from_multiple_objects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Detaches the given tag from the input objects. If a tag is already
|
||||
removed from the object, then the individual method is a no-op and an
|
||||
error will not be added to
|
||||
@ -1305,7 +1305,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.list_attachable_tags">
|
||||
<code class="descname">list_attachable_tags</code><span class="sig-paren">(</span><em>object_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attachable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list_attachable_tags</code><span class="sig-paren">(</span><em class="sig-param">object_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attachable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fetches the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of attachable tags for the given object,
|
||||
omitting the tags that have already been attached. Criteria for
|
||||
attachability is calculated based on tagging cardinality
|
||||
@ -1340,7 +1340,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.list_attached_objects">
|
||||
<code class="descname">list_attached_objects</code><span class="sig-paren">(</span><em>tag_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list_attached_objects</code><span class="sig-paren">(</span><em class="sig-param">tag_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fetches the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of attached objects for the given tag. To
|
||||
invoke this method, you need the read privilege on the input tag. Only
|
||||
those objects for which you have the read privilege will be returned.</p>
|
||||
@ -1373,7 +1373,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags">
|
||||
<code class="descname">list_attached_objects_on_tags</code><span class="sig-paren">(</span><em>tag_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list_attached_objects_on_tags</code><span class="sig-paren">(</span><em class="sig-param">tag_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fetches the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.TagToObjects" title="com.vmware.cis.tagging_client.TagAssociation.TagToObjects"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagAssociation.TagToObjects</span></code></a>
|
||||
describing the input tag identifiers and the objects they are attached
|
||||
to. To invoke this method, you need the read privilege on each input
|
||||
@ -1402,7 +1402,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.list_attached_tags">
|
||||
<code class="descname">list_attached_tags</code><span class="sig-paren">(</span><em>object_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list_attached_tags</code><span class="sig-paren">(</span><em class="sig-param">object_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fetches the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of tags attached to the given object. To
|
||||
invoke this method, you need the read privilege on the input object.
|
||||
The <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> will only contain those tags for which you have the
|
||||
@ -1433,7 +1433,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects">
|
||||
<code class="descname">list_attached_tags_on_objects</code><span class="sig-paren">(</span><em>object_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list_attached_tags_on_objects</code><span class="sig-paren">(</span><em class="sig-param">object_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fetches the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.ObjectToTags" title="com.vmware.cis.tagging_client.TagAssociation.ObjectToTags"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagAssociation.ObjectToTags</span></code></a>
|
||||
describing the input object identifiers and the tags attached to each
|
||||
object. To invoke this method, you need the read privilege on each
|
||||
@ -1462,7 +1462,7 @@ if the user can not be authenticated.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.tagging_client.TagModel">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.cis.tagging_client.</code><code class="descname">TagModel</code><span class="sig-paren">(</span><em>id=None</em>, <em>category_id=None</em>, <em>name=None</em>, <em>description=None</em>, <em>used_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagModel" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis.tagging_client.</code><code class="sig-name descname">TagModel</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">category_id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">used_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagModel" 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">TagModel</span></code> class defines a tag that can be attached to vSphere
|
||||
objects.</p>
|
||||
@ -1506,7 +1506,7 @@ You should not modify other users subscription from this
|
||||
managing tasks.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.task_client.CommonInfo">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.cis.task_client.</code><code class="descname">CommonInfo</code><span class="sig-paren">(</span><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.cis.task_client.CommonInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis.task_client.</code><code class="sig-name descname">CommonInfo</code><span class="sig-paren">(</span><em class="sig-param">description=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">operation=None</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">target=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">cancelable=None</em>, <em class="sig-param">error=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.task_client.CommonInfo" 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">CommonInfo</span></code> class contains information common to all tasks. This
|
||||
class was added in vSphere API 6.7.</p>
|
||||
@ -1578,7 +1578,7 @@ system.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.task_client.Info">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.cis.task_client.</code><code class="descname">Info</code><span class="sig-paren">(</span><em>progress=None</em>, <em>result=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.cis.task_client.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis.task_client.</code><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">progress=None</em>, <em class="sig-param">result=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">operation=None</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">target=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">cancelable=None</em>, <em class="sig-param">error=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.task_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 task. This class was added
|
||||
in vSphere API 6.7.</p>
|
||||
@ -1664,7 +1664,7 @@ system.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.task_client.Progress">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.cis.task_client.</code><code class="descname">Progress</code><span class="sig-paren">(</span><em>total=None</em>, <em>completed=None</em>, <em>message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.task_client.Progress" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis.task_client.</code><code class="sig-name descname">Progress</code><span class="sig-paren">(</span><em class="sig-param">total=None</em>, <em class="sig-param">completed=None</em>, <em class="sig-param">message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.task_client.Progress" 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">Progress</span></code> class contains information describe the progress of an
|
||||
operation. This class was added in vSphere API 6.7.</p>
|
||||
@ -1689,7 +1689,7 @@ vSphere API 6.7.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.task_client.Status">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.cis.task_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.task_client.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis.task_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.task_client.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Status</span></code> class defines the status values that can be reported for an
|
||||
operation. This enumeration was added in vSphere API 6.7.</p>
|
||||
@ -1710,34 +1710,34 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.cis.task_client.Status.BLOCKED">
|
||||
<code class="descname">BLOCKED</code><em class="property"> = Status(string='BLOCKED')</em><a class="headerlink" href="#com.vmware.cis.task_client.Status.BLOCKED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">BLOCKED</code><em class="property"> = Status(string='BLOCKED')</em><a class="headerlink" href="#com.vmware.cis.task_client.Status.BLOCKED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The operation is blocked. This class attribute was added in vSphere API
|
||||
6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.cis.task_client.Status.FAILED">
|
||||
<code class="descname">FAILED</code><em class="property"> = Status(string='FAILED')</em><a class="headerlink" href="#com.vmware.cis.task_client.Status.FAILED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FAILED</code><em class="property"> = Status(string='FAILED')</em><a class="headerlink" href="#com.vmware.cis.task_client.Status.FAILED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The operation failed. This class attribute was added in vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.cis.task_client.Status.PENDING">
|
||||
<code class="descname">PENDING</code><em class="property"> = Status(string='PENDING')</em><a class="headerlink" href="#com.vmware.cis.task_client.Status.PENDING" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">PENDING</code><em class="property"> = Status(string='PENDING')</em><a class="headerlink" href="#com.vmware.cis.task_client.Status.PENDING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The operation is in pending state. This class attribute was added in
|
||||
vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.cis.task_client.Status.RUNNING">
|
||||
<code class="descname">RUNNING</code><em class="property"> = Status(string='RUNNING')</em><a class="headerlink" href="#com.vmware.cis.task_client.Status.RUNNING" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RUNNING</code><em class="property"> = Status(string='RUNNING')</em><a class="headerlink" href="#com.vmware.cis.task_client.Status.RUNNING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The operation is in progress. This class attribute was added in vSphere API
|
||||
6.7.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.cis.task_client.Status.SUCCEEDED">
|
||||
<code class="descname">SUCCEEDED</code><em class="property"> = Status(string='SUCCEEDED')</em><a class="headerlink" href="#com.vmware.cis.task_client.Status.SUCCEEDED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SUCCEEDED</code><em class="property"> = Status(string='SUCCEEDED')</em><a class="headerlink" href="#com.vmware.cis.task_client.Status.SUCCEEDED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The operation completed successfully. This class attribute was added in
|
||||
vSphere API 6.7.</p>
|
||||
</dd></dl>
|
||||
@ -1746,7 +1746,7 @@ vSphere API 6.7.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.cis.task_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.cis.task_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.cis.task_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.cis.task_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.task_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">
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.content package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
<title>com.vmware.content package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -216,7 +216,7 @@
|
||||
managing the library’s items, subscription, publication, and storage.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Item">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library_client.</code><code class="descname">Item</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library_client.</code><code class="sig-name descname">Item</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item" 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">Item</span></code> class provides methods for managing library items.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -226,7 +226,7 @@ managing the library’s items, subscription, publication, and storage.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Item.DestinationSpec">
|
||||
<em class="property">class </em><code class="descname">DestinationSpec</code><span class="sig-paren">(</span><em>subscription=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.DestinationSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">DestinationSpec</code><span class="sig-paren">(</span><em class="sig-param">subscription=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.DestinationSpec" 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">Item.DestinationSpec</span></code> class contains information required to publish
|
||||
the library item to a specific subscription. This class was added in
|
||||
@ -252,7 +252,7 @@ identifier for the resource type:
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Item.FindSpec">
|
||||
<em class="property">class </em><code class="descname">FindSpec</code><span class="sig-paren">(</span><em>name=None</em>, <em>library_id=None</em>, <em>source_id=None</em>, <em>type=None</em>, <em>cached=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.FindSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">FindSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">library_id=None</em>, <em class="sig-param">source_id=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">cached=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.FindSpec" 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">Item.FindSpec</span></code> class specifies the properties that can be used as a
|
||||
filter to find library items. When multiple attributes are specified, all
|
||||
@ -297,13 +297,13 @@ If not specified all library items are searched.</p></li>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library_client.Item.RESOURCE_TYPE">
|
||||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.library.Item'</em><a class="headerlink" href="#com.vmware.content.library_client.Item.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.library.Item'</em><a class="headerlink" href="#com.vmware.content.library_client.Item.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for item.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Item.copy">
|
||||
<code class="descname">copy</code><span class="sig-paren">(</span><em>source_library_item_id</em>, <em>destination_create_spec</em>, <em>client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.copy" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">copy</code><span class="sig-paren">(</span><em class="sig-param">source_library_item_id</em>, <em class="sig-param">destination_create_spec</em>, <em class="sig-param">client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.copy" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Copies a library item.</p>
|
||||
<p>Copying a library item allows a duplicate to be made within the same or
|
||||
different library. The copy occurs by first creating a new library
|
||||
@ -395,7 +395,7 @@ attribute <code class="xref py py-attr docutils literal notranslate"><span class
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Item.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>create_spec</em>, <em>client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">create_spec</em>, <em class="sig-param">client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a new library item.</p>
|
||||
<p>A new library item is created without any content. After creation,
|
||||
content can be added through the
|
||||
@ -473,7 +473,7 @@ attribute <code class="xref py py-attr docutils literal notranslate"><span class
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Item.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>library_item_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">library_item_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes a library item.</p>
|
||||
<p>This method will immediately remove the item from the library that owns
|
||||
it. The content of the item will be asynchronously removed from the
|
||||
@ -519,7 +519,7 @@ the parameter <code class="docutils literal notranslate"><span class="pre">libra
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Item.find">
|
||||
<code class="descname">find</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.find" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">find</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.find" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns identifiers of all the visible (as determined by authorization
|
||||
policy) library items matching the requested <a class="reference internal" href="#com.vmware.content.library_client.Item.FindSpec" title="com.vmware.content.library_client.Item.FindSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Item.FindSpec</span></code></a>.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -554,7 +554,7 @@ attribute <code class="xref py py-attr docutils literal notranslate"><span class
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Item.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>library_item_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">library_item_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the <a class="reference internal" href="#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">ItemModel</span></code></a> with the given identifier.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -585,7 +585,7 @@ the parameter <code class="docutils literal notranslate"><span class="pre">libra
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Item.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>library_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">library_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the identifiers of all items in the given library.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -619,7 +619,7 @@ parameter <code class="docutils literal notranslate"><span class="pre">library_i
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Item.publish">
|
||||
<code class="descname">publish</code><span class="sig-paren">(</span><em>library_item_id</em>, <em>force_sync_content</em>, <em>subscriptions=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.publish" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">publish</code><span class="sig-paren">(</span><em class="sig-param">library_item_id</em>, <em class="sig-param">force_sync_content</em>, <em class="sig-param">subscriptions=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.publish" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Publishes the library item to specified subscriptions of the library.
|
||||
If no subscriptions are specified, then publishes the library item to
|
||||
all subscriptions of the library. This method was added in vSphere API
|
||||
@ -681,7 +681,7 @@ the parameter <code class="docutils literal notranslate"><span class="pre">libra
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Item.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>library_item_id</em>, <em>update_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.update" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">library_item_id</em>, <em class="sig-param">update_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Item.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Updates the specified properties of a library item.</p>
|
||||
<p>This is an incremental update to the library item. Attributes that are
|
||||
None in the update specification are left unchanged.</p>
|
||||
@ -747,7 +747,7 @@ the parameter <code class="docutils literal notranslate"><span class="pre">libra
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.ItemModel">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library_client.</code><code class="descname">ItemModel</code><span class="sig-paren">(</span><em>id=None</em>, <em>library_id=None</em>, <em>content_version=None</em>, <em>creation_time=None</em>, <em>description=None</em>, <em>last_modified_time=None</em>, <em>last_sync_time=None</em>, <em>metadata_version=None</em>, <em>name=None</em>, <em>cached=None</em>, <em>size=None</em>, <em>type=None</em>, <em>version=None</em>, <em>source_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.ItemModel" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library_client.</code><code class="sig-name descname">ItemModel</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">library_id=None</em>, <em class="sig-param">content_version=None</em>, <em class="sig-param">creation_time=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">last_modified_time=None</em>, <em class="sig-param">last_sync_time=None</em>, <em class="sig-param">metadata_version=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">cached=None</em>, <em class="sig-param">size=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">source_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.ItemModel" 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">ItemModel</span></code> class represents a library item that has been stored in a
|
||||
library.</p>
|
||||
@ -909,7 +909,7 @@ is not used for the <code class="docutils literal notranslate"><span class="pre"
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.OptimizationInfo">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library_client.</code><code class="descname">OptimizationInfo</code><span class="sig-paren">(</span><em>optimize_remote_publishing=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.OptimizationInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library_client.</code><code class="sig-name descname">OptimizationInfo</code><span class="sig-paren">(</span><em class="sig-param">optimize_remote_publishing=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.OptimizationInfo" 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">OptimizationInfo</span></code> class defines different optimizations and
|
||||
optimization parameters applied to particular library.</p>
|
||||
@ -944,7 +944,7 @@ be optmized for specific use case. It is not used for the
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.PublishInfo">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library_client.</code><code class="descname">PublishInfo</code><span class="sig-paren">(</span><em>authentication_method=None</em>, <em>published=None</em>, <em>publish_url=None</em>, <em>user_name=None</em>, <em>password=None</em>, <em>current_password=None</em>, <em>persist_json_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.PublishInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library_client.</code><code class="sig-name descname">PublishInfo</code><span class="sig-paren">(</span><em class="sig-param">authentication_method=None</em>, <em class="sig-param">published=None</em>, <em class="sig-param">publish_url=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">password=None</em>, <em class="sig-param">current_password=None</em>, <em class="sig-param">persist_json_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.PublishInfo" 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">PublishInfo</span></code> class defines how a local library is published publicly
|
||||
for synchronization to other libraries.</p>
|
||||
@ -1055,7 +1055,7 @@ methods. It is optional for the <code class="docutils literal notranslate"><span
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.PublishInfo.AuthenticationMethod">
|
||||
<em class="property">class </em><code class="descname">AuthenticationMethod</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">AuthenticationMethod</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod" 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">PublishInfo.AuthenticationMethod</span></code> class indicates how a subscribed
|
||||
library should authenticate to the published library endpoint.</p>
|
||||
@ -1076,14 +1076,14 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC">
|
||||
<code class="descname">BASIC</code><em class="property"> = AuthenticationMethod(string='BASIC')</em><a class="headerlink" href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">BASIC</code><em class="property"> = AuthenticationMethod(string='BASIC')</em><a class="headerlink" href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.BASIC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Require HTTP Basic authentication matching a specified username and
|
||||
password.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE">
|
||||
<code class="descname">NONE</code><em class="property"> = AuthenticationMethod(string='NONE')</em><a class="headerlink" href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NONE</code><em class="property"> = AuthenticationMethod(string='NONE')</em><a class="headerlink" href="#com.vmware.content.library_client.PublishInfo.AuthenticationMethod.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Require no authentication.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -1093,7 +1093,7 @@ password.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.SourceInfo">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library_client.</code><code class="descname">SourceInfo</code><span class="sig-paren">(</span><em>source_library=None</em>, <em>subscription=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.SourceInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library_client.</code><code class="sig-name descname">SourceInfo</code><span class="sig-paren">(</span><em class="sig-param">source_library=None</em>, <em class="sig-param">subscription=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_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>The <code class="docutils literal notranslate"><span class="pre">SourceInfo</span></code> class contains information about the source published
|
||||
library of a subscribed library. This class was added in vSphere API 6.7.2.</p>
|
||||
@ -1133,7 +1133,7 @@ methods. It is optional for the <code class="docutils literal notranslate"><span
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.StorageBacking">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library_client.</code><code class="descname">StorageBacking</code><span class="sig-paren">(</span><em>type=None</em>, <em>datastore_id=None</em>, <em>storage_uri=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.StorageBacking" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library_client.</code><code class="sig-name descname">StorageBacking</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">datastore_id=None</em>, <em class="sig-param">storage_uri=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.StorageBacking" 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">StorageBacking</span></code> class defines a storage location where content in a
|
||||
library will be stored. The storage location can either be a Datastore or
|
||||
@ -1202,7 +1202,7 @@ of <code class="docutils literal notranslate"><span class="pre">type</span></cod
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.StorageBacking.Type">
|
||||
<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.content.library_client.StorageBacking.Type" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.StorageBacking.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">StorageBacking.Type</span></code> class specifies the type of the
|
||||
<a class="reference internal" href="#com.vmware.content.library_client.StorageBacking" title="com.vmware.content.library_client.StorageBacking"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageBacking</span></code></a>.</p>
|
||||
@ -1223,7 +1223,7 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library_client.StorageBacking.Type.DATASTORE">
|
||||
<code class="descname">DATASTORE</code><em class="property"> = Type(string='DATASTORE')</em><a class="headerlink" href="#com.vmware.content.library_client.StorageBacking.Type.DATASTORE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">DATASTORE</code><em class="property"> = Type(string='DATASTORE')</em><a class="headerlink" href="#com.vmware.content.library_client.StorageBacking.Type.DATASTORE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The content of the library will be stored on a datastore.</p>
|
||||
<p>These are vCenter Server managed datastores, and are logical containers
|
||||
that hide specifics of each storage device. Depending on the type of
|
||||
@ -1237,7 +1237,7 @@ formats:</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library_client.StorageBacking.Type.OTHER">
|
||||
<code class="descname">OTHER</code><em class="property"> = Type(string='OTHER')</em><a class="headerlink" href="#com.vmware.content.library_client.StorageBacking.Type.OTHER" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">OTHER</code><em class="property"> = Type(string='OTHER')</em><a class="headerlink" href="#com.vmware.content.library_client.StorageBacking.Type.OTHER" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The content of the library will be stored on a remote file system.</p>
|
||||
<blockquote>
|
||||
<div><p>Supports the following remote file systems:</p>
|
||||
@ -1254,7 +1254,7 @@ formats:</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library_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.library_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_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">
|
||||
@ -1266,7 +1266,7 @@ formats:</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.SubscribedItem">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library_client.</code><code class="descname">SubscribedItem</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.SubscribedItem" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library_client.</code><code class="sig-name descname">SubscribedItem</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.SubscribedItem" 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">SubscribedItem</span></code> class manages the unique features of library items
|
||||
that are members of a subscribed library.</p>
|
||||
@ -1277,7 +1277,7 @@ that are members of a subscribed library.</p>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.SubscribedItem.evict">
|
||||
<code class="descname">evict</code><span class="sig-paren">(</span><em>library_item_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.SubscribedItem.evict" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">evict</code><span class="sig-paren">(</span><em class="sig-param">library_item_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.SubscribedItem.evict" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Evicts the cached content of a library item in a subscribed library.</p>
|
||||
<p>This method allows the cached content of a library item to be removed
|
||||
to free up storage capacity. This method will only work when a library
|
||||
@ -1332,7 +1332,7 @@ the parameter <code class="docutils literal notranslate"><span class="pre">libra
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.SubscribedItem.sync">
|
||||
<code class="descname">sync</code><span class="sig-paren">(</span><em>library_item_id</em>, <em>force_sync_content</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.SubscribedItem.sync" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">sync</code><span class="sig-paren">(</span><em class="sig-param">library_item_id</em>, <em class="sig-param">force_sync_content</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.SubscribedItem.sync" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Forces the synchronization of an individual library item in a
|
||||
subscribed library.</p>
|
||||
<p>Synchronizing an individual item will update that item’s metadata from
|
||||
@ -1402,7 +1402,7 @@ the parameter <code class="docutils literal notranslate"><span class="pre">libra
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.SubscriptionInfo">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library_client.</code><code class="descname">SubscriptionInfo</code><span class="sig-paren">(</span><em>authentication_method=None</em>, <em>automatic_sync_enabled=None</em>, <em>on_demand=None</em>, <em>password=None</em>, <em>ssl_thumbprint=None</em>, <em>subscription_url=None</em>, <em>user_name=None</em>, <em>source_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.SubscriptionInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library_client.</code><code class="sig-name descname">SubscriptionInfo</code><span class="sig-paren">(</span><em class="sig-param">authentication_method=None</em>, <em class="sig-param">automatic_sync_enabled=None</em>, <em class="sig-param">on_demand=None</em>, <em class="sig-param">password=None</em>, <em class="sig-param">ssl_thumbprint=None</em>, <em class="sig-param">subscription_url=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">source_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.SubscriptionInfo" 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">SubscriptionInfo</span></code> class defines the subscription behavior for a
|
||||
subscribed library.</p>
|
||||
@ -1524,7 +1524,7 @@ is optional for the <code class="docutils literal notranslate"><span class="pre"
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod">
|
||||
<em class="property">class </em><code class="descname">AuthenticationMethod</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">AuthenticationMethod</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod" 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>Indicate how the subscribed library should authenticate with the published
|
||||
library endpoint.</p>
|
||||
@ -1545,14 +1545,14 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod.BASIC">
|
||||
<code class="descname">BASIC</code><em class="property"> = AuthenticationMethod(string='BASIC')</em><a class="headerlink" href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod.BASIC" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">BASIC</code><em class="property"> = AuthenticationMethod(string='BASIC')</em><a class="headerlink" href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod.BASIC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Require HTTP Basic authentication matching a specified username and
|
||||
password.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod.NONE">
|
||||
<code class="descname">NONE</code><em class="property"> = AuthenticationMethod(string='NONE')</em><a class="headerlink" href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NONE</code><em class="property"> = AuthenticationMethod(string='NONE')</em><a class="headerlink" href="#com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Require no authentication.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -1562,7 +1562,7 @@ password.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library_client.</code><code class="descname">Subscriptions</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library_client.</code><code class="sig-name descname">Subscriptions</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions" 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">Subscriptions</span></code> class provides methods for managing the subscription
|
||||
information of the subscribers of a published library. This class was added
|
||||
@ -1574,7 +1574,7 @@ in vSphere API 6.7.2.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.CreateSpec">
|
||||
<em class="property">class </em><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>subscribed_library=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">subscribed_library=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.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">Subscriptions.CreateSpec</span></code> class defines the information required to
|
||||
create a new subscription of the published library. This class was added in
|
||||
@ -1594,7 +1594,7 @@ subscription. This attribute was added in vSphere API 6.7.2.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.CreateSpecNewSubscribedLibrary">
|
||||
<em class="property">class </em><code class="descname">CreateSpecNewSubscribedLibrary</code><span class="sig-paren">(</span><em>name=None</em>, <em>description=None</em>, <em>storage_backings=None</em>, <em>automatic_sync_enabled=None</em>, <em>on_demand=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecNewSubscribedLibrary" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpecNewSubscribedLibrary</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">storage_backings=None</em>, <em class="sig-param">automatic_sync_enabled=None</em>, <em class="sig-param">on_demand=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecNewSubscribedLibrary" 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">Subscriptions.CreateSpecNewSubscribedLibrary</span></code> class defines the
|
||||
information required to create a new subscribed library. This class was
|
||||
@ -1630,7 +1630,7 @@ only on demand. This attribute was added in vSphere API 6.7.2.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.CreateSpecPlacement">
|
||||
<em class="property">class </em><code class="descname">CreateSpecPlacement</code><span class="sig-paren">(</span><em>folder=None</em>, <em>cluster=None</em>, <em>resource_pool=None</em>, <em>host=None</em>, <em>network=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecPlacement" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpecPlacement</code><span class="sig-paren">(</span><em class="sig-param">folder=None</em>, <em class="sig-param">cluster=None</em>, <em class="sig-param">resource_pool=None</em>, <em class="sig-param">host=None</em>, <em class="sig-param">network=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecPlacement" 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">Subscriptions.CreateSpecPlacement</span></code> class defines the placement
|
||||
information for the subscribed library’s virtual machine template library
|
||||
@ -1714,7 +1714,7 @@ network.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary">
|
||||
<em class="property">class </em><code class="descname">CreateSpecSubscribedLibrary</code><span class="sig-paren">(</span><em>target=None</em>, <em>new_subscribed_library=None</em>, <em>subscribed_library=None</em>, <em>location=None</em>, <em>vcenter=None</em>, <em>placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpecSubscribedLibrary</code><span class="sig-paren">(</span><em class="sig-param">target=None</em>, <em class="sig-param">new_subscribed_library=None</em>, <em class="sig-param">subscribed_library=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">vcenter=None</em>, <em class="sig-param">placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary" 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">Subscriptions.CreateSpecSubscribedLibrary</span></code> class defines the
|
||||
subscribed library information used to create the subscription. This class
|
||||
@ -1768,7 +1768,7 @@ machine template items will fail.</p></li>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary.Target">
|
||||
<em class="property">class </em><code class="descname">Target</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary.Target" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Target</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary.Target" 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">Subscriptions.CreateSpecSubscribedLibrary.Target</span></code> class defines the
|
||||
options related to the target subscribed library which will be associated
|
||||
@ -1790,14 +1790,14 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary.Target.CREATE_NEW">
|
||||
<code class="descname">CREATE_NEW</code><em class="property"> = Target(string='CREATE_NEW')</em><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary.Target.CREATE_NEW" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">CREATE_NEW</code><em class="property"> = Target(string='CREATE_NEW')</em><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary.Target.CREATE_NEW" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new subscribed library. This class attribute was added in vSphere
|
||||
API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary.Target.USE_EXISTING">
|
||||
<code class="descname">USE_EXISTING</code><em class="property"> = Target(string='USE_EXISTING')</em><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary.Target.USE_EXISTING" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">USE_EXISTING</code><em class="property"> = Target(string='USE_EXISTING')</em><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary.Target.USE_EXISTING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use the specified existing subscribed library. This class attribute was
|
||||
added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
@ -1808,7 +1808,7 @@ added in vSphere API 6.7.2.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.CreateSpecVcenter">
|
||||
<em class="property">class </em><code class="descname">CreateSpecVcenter</code><span class="sig-paren">(</span><em>hostname=None</em>, <em>https_port=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecVcenter" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpecVcenter</code><span class="sig-paren">(</span><em class="sig-param">hostname=None</em>, <em class="sig-param">https_port=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.CreateSpecVcenter" 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">Subscriptions.CreateSpecVcenter</span></code> class defines information about the
|
||||
vCenter Server instance where the subscribed library associated with the
|
||||
@ -1834,7 +1834,7 @@ If None, port 443 will be used.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>subscribed_library=None</em>, <em>subscribed_library_name=None</em>, <em>subscribed_library_location=None</em>, <em>subscribed_library_vcenter=None</em>, <em>subscribed_library_placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">subscribed_library=None</em>, <em class="sig-param">subscribed_library_name=None</em>, <em class="sig-param">subscribed_library_location=None</em>, <em class="sig-param">subscribed_library_vcenter=None</em>, <em class="sig-param">subscribed_library_placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.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">Subscriptions.Info</span></code> class contains information about the
|
||||
subscription. This class was added in vSphere API 6.7.2.</p>
|
||||
@ -1872,7 +1872,7 @@ machine template items. This attribute was added in vSphere API
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.Location">
|
||||
<em class="property">class </em><code class="descname">Location</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.Location" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Location</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.Location" 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">Subscriptions.Location</span></code> class defines the location of subscribed
|
||||
library relative to the published library. This enumeration was added in
|
||||
@ -1894,14 +1894,14 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.Location.LOCAL">
|
||||
<code class="descname">LOCAL</code><em class="property"> = Location(string='LOCAL')</em><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.Location.LOCAL" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">LOCAL</code><em class="property"> = Location(string='LOCAL')</em><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.Location.LOCAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The subscribed library belongs to the same vCenter instance as the
|
||||
published library. This class attribute was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.Location.REMOTE">
|
||||
<code class="descname">REMOTE</code><em class="property"> = Location(string='REMOTE')</em><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.Location.REMOTE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">REMOTE</code><em class="property"> = Location(string='REMOTE')</em><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.Location.REMOTE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The subscribed library belongs to a different vCenter instance than the
|
||||
published library. This class attribute was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
@ -1910,7 +1910,7 @@ published library. This class attribute was added in vSphere API 6.7.2.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.PlacementInfo">
|
||||
<em class="property">class </em><code class="descname">PlacementInfo</code><span class="sig-paren">(</span><em>folder=None</em>, <em>cluster=None</em>, <em>resource_pool=None</em>, <em>host=None</em>, <em>network=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.PlacementInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">PlacementInfo</code><span class="sig-paren">(</span><em class="sig-param">folder=None</em>, <em class="sig-param">cluster=None</em>, <em class="sig-param">resource_pool=None</em>, <em class="sig-param">host=None</em>, <em class="sig-param">network=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.PlacementInfo" 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">Subscriptions.PlacementInfo</span></code> class contains the placement
|
||||
information for the subscribed library’s virtual machine template library
|
||||
@ -1980,14 +1980,14 @@ with the subscription does not have a network.</p></li>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.RESOURCE_TYPE">
|
||||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.library.Subscriptions'</em><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.library.Subscriptions'</em><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for Subscription resource. This class attribute was added in
|
||||
vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.Summary">
|
||||
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>subscription=None</em>, <em>subscribed_library=None</em>, <em>subscribed_library_name=None</em>, <em>subscribed_library_vcenter_hostname=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">subscription=None</em>, <em class="sig-param">subscribed_library=None</em>, <em class="sig-param">subscribed_library_name=None</em>, <em class="sig-param">subscribed_library_vcenter_hostname=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.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">Subscriptions.Summary</span></code> class contains commonly used information
|
||||
about the subscription. This class was added in vSphere API 6.7.2.</p>
|
||||
@ -2027,7 +2027,7 @@ vCenter Server instance as the published library.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.UpdateSpec">
|
||||
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>subscribed_library_vcenter=None</em>, <em>subscribed_library_placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">subscribed_library_vcenter=None</em>, <em class="sig-param">subscribed_library_placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.UpdateSpec" 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">Subscriptions.UpdateSpec</span></code> class defines information required to
|
||||
update the subscription. This class was added in vSphere API 6.7.2.</p>
|
||||
@ -2057,7 +2057,7 @@ be unchanged.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.UpdateSpecPlacement">
|
||||
<em class="property">class </em><code class="descname">UpdateSpecPlacement</code><span class="sig-paren">(</span><em>folder=None</em>, <em>cluster=None</em>, <em>resource_pool=None</em>, <em>host=None</em>, <em>network=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.UpdateSpecPlacement" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">UpdateSpecPlacement</code><span class="sig-paren">(</span><em class="sig-param">folder=None</em>, <em class="sig-param">cluster=None</em>, <em class="sig-param">resource_pool=None</em>, <em class="sig-param">host=None</em>, <em class="sig-param">network=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.UpdateSpecPlacement" 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">Subscriptions.UpdateSpecPlacement</span></code> class defines the placement
|
||||
information for the subscribed library’s virtual machine template library
|
||||
@ -2141,7 +2141,7 @@ will not be backed by a network.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.UpdateSpecVcenter">
|
||||
<em class="property">class </em><code class="descname">UpdateSpecVcenter</code><span class="sig-paren">(</span><em>hostname=None</em>, <em>https_port=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.UpdateSpecVcenter" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">UpdateSpecVcenter</code><span class="sig-paren">(</span><em class="sig-param">hostname=None</em>, <em class="sig-param">https_port=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.UpdateSpecVcenter" 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">Subscriptions.UpdateSpecVcenter</span></code> class defines information about the
|
||||
vCenter Server instance where the subscribed library associated with the
|
||||
@ -2169,7 +2169,7 @@ If None, the value is unchanged.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.VcenterInfo">
|
||||
<em class="property">class </em><code class="descname">VcenterInfo</code><span class="sig-paren">(</span><em>hostname=None</em>, <em>https_port=None</em>, <em>server_guid=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.VcenterInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">VcenterInfo</code><span class="sig-paren">(</span><em class="sig-param">hostname=None</em>, <em class="sig-param">https_port=None</em>, <em class="sig-param">server_guid=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.VcenterInfo" 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">Subscriptions.VcenterInfo</span></code> class contains information about the
|
||||
vCenter Server instance where the subscribed library associated with the
|
||||
@ -2196,7 +2196,7 @@ library exists. This attribute was added in vSphere API 6.7.2.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>library</em>, <em>spec</em>, <em>client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">library</em>, <em class="sig-param">spec</em>, <em class="sig-param">client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a subscription of the published library. This method was added
|
||||
in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -2280,7 +2280,7 @@ parameter <code class="docutils literal notranslate"><span class="pre">library</
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>library</em>, <em>subscription</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">library</em>, <em class="sig-param">subscription</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes the specified subscription of the published library. The
|
||||
subscribed library associated with the subscription will not be
|
||||
deleted. This method was added in vSphere API 6.7.2.</p>
|
||||
@ -2339,7 +2339,7 @@ parameter <code class="docutils literal notranslate"><span class="pre">library</
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>library</em>, <em>subscription</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">library</em>, <em class="sig-param">subscription</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about the specified subscription of the published
|
||||
library. This method was added in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -2401,7 +2401,7 @@ parameter <code class="docutils literal notranslate"><span class="pre">library</
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>library</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">library</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lists the subscriptions of the published library. This method was added
|
||||
in vSphere API 6.7.2.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -2455,7 +2455,7 @@ parameter <code class="docutils literal notranslate"><span class="pre">library</
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library_client.Subscriptions.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>library</em>, <em>subscription</em>, <em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.update" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">library</em>, <em class="sig-param">subscription</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library_client.Subscriptions.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Updates the specified subscription of the published library.</p>
|
||||
<p>This is an incremental update to the subscription. Except for the
|
||||
<a class="reference internal" href="#com.vmware.content.library_client.Subscriptions.UpdateSpecPlacement" title="com.vmware.content.library_client.Subscriptions.UpdateSpecPlacement"><code class="xref py py-class docutils literal notranslate"><span class="pre">Subscriptions.UpdateSpecPlacement</span></code></a> class, attributes that are
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.content.library package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
<title>com.vmware.content.library package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -195,9 +195,190 @@
|
||||
<span id="com-vmware-content-library-item-client-module"></span><h2>com.vmware.content.library.item_client module<a class="headerlink" href="#module-com.vmware.content.library.item_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Content Library Item module provides classes and classes for managing files
|
||||
in a library item.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.Changes">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item_client.</code><code class="sig-name descname">Changes</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Changes" 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">Changes</span></code> class provides methods to get a history of the content
|
||||
changes made to a library item. This class was added in vSphere API 6.9.1.</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.content.library.item_client.Changes.Info">
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">time=None</em>, <em class="sig-param">user=None</em>, <em class="sig-param">message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Changes.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">Changes.Info</span></code> class contains information about a library item
|
||||
change. This class was added in vSphere API 6.9.1.</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>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The date and time when the item content was changed. This attribute
|
||||
was added in vSphere API 6.9.1.</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>) – The user who made the content change. This attribute was added in
|
||||
vSphere API 6.9.1.
|
||||
This attribute will be None if the user could not be determined.</p></li>
|
||||
<li><p><strong>message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The full message describing the content change. This attribute was
|
||||
added in vSphere API 6.9.1.
|
||||
This attribute will be None if a message was not provided when the
|
||||
item content was changed.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.Changes.RESOURCE_TYPE">
|
||||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.library.item.Version'</em><a class="headerlink" href="#com.vmware.content.library.item_client.Changes.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for library item versions. This class attribute was added in
|
||||
vSphere API 6.9.1.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.Changes.Summary">
|
||||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">version=None</em>, <em class="sig-param">time=None</em>, <em class="sig-param">user=None</em>, <em class="sig-param">short_message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Changes.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">Changes.Summary</span></code> class contains commonly used information about a
|
||||
library item change. This class was added in vSphere API 6.9.1.</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">str</span></code>) – The version of the library item. This attribute was added in
|
||||
vSphere API 6.9.1.
|
||||
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.Version</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.Version</span></code>.</p></li>
|
||||
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The date and time when the item content was changed. This attribute
|
||||
was added in vSphere API 6.9.1.</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>) – The user who made the content change. This attribute was added in
|
||||
vSphere API 6.9.1.
|
||||
This attribute will be None if the user could not be determined.</p></li>
|
||||
<li><p><strong>short_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The short message describing the content change. The message is
|
||||
truncated to the first 80 characters or first non-leading newline
|
||||
character, whichever length is shorter. This attribute was added in
|
||||
vSphere API 6.9.1.
|
||||
This attribute will be None if a message was not provided when the
|
||||
item content was changed.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.Changes.get">
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">library_item</em>, <em class="sig-param">version</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Changes.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about a library item change. This method was added
|
||||
in vSphere API 6.9.1.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Library item identifer.
|
||||
The parameter must 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>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Library item version.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item_client.Changes.Info" title="com.vmware.content.library.item_client.Changes.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Changes.Info</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Information about the specified library item change.</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 library item or version is not found.</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 that requested the method cannot 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 that requested the method is not authorized to perform
|
||||
the method.</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>
|
||||
<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="simple">
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
||||
the parameter <code class="docutils literal notranslate"><span class="pre">library_item</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.Changes.list">
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">library_item</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Changes.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns commonly used information about the content changes made to a
|
||||
library item. This method was added in vSphere API 6.9.1.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Library item identifier.
|
||||
The parameter must be an identifier for the resource type:
|
||||
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item_client.Changes.list" title="com.vmware.content.library.item_client.Changes.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.content.library.item_client.Changes.Summary" title="com.vmware.content.library.item_client.Changes.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Changes.Summary</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>List of commonly used information about the library item changes.</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 library item is not found.</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 that requested the method cannot 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 that requested the method is not authorized to perform
|
||||
the method.</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>
|
||||
<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="simple">
|
||||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
||||
the parameter <code class="docutils literal notranslate"><span class="pre">library_item</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSession">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">DownloadSession</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item_client.</code><code class="sig-name descname">DownloadSession</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession" 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">DownloadSession</span></code> class manipulates download sessions, which are used
|
||||
to download content from the Content Library Service.</p>
|
||||
@ -213,13 +394,13 @@ class provides access to the download links.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSession.RESOURCE_TYPE">
|
||||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.library.item.DownloadSession'</em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.library.item.DownloadSession'</em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for a download session.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSession.cancel">
|
||||
<code class="descname">cancel</code><span class="sig-paren">(</span><em>download_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.cancel" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">cancel</code><span class="sig-paren">(</span><em class="sig-param">download_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.cancel" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cancels the download session. This method will abort any ongoing
|
||||
transfers and invalidate transfer urls that the client may be
|
||||
downloading from.</p>
|
||||
@ -250,7 +431,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSession.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>create_spec</em>, <em>client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">create_spec</em>, <em class="sig-param">client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a new download session.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -297,7 +478,7 @@ the attribute <code class="xref py py-attr docutils literal notranslate"><span c
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSession.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>download_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">download_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes a download session. This removes the session and all
|
||||
information associated with it.</p>
|
||||
<p>Removing a download session leaves any current transfers for that
|
||||
@ -330,7 +511,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSession.fail">
|
||||
<code class="descname">fail</code><span class="sig-paren">(</span><em>download_session_id</em>, <em>client_error_message</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.fail" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">fail</code><span class="sig-paren">(</span><em class="sig-param">download_session_id</em>, <em class="sig-param">client_error_message</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Terminates the download session with a client specified error message.</p>
|
||||
<p>This is useful in transmitting client side failures (for example, not
|
||||
being able to download a file) to the server side.</p>
|
||||
@ -366,7 +547,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSession.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>download_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">download_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets the download session with the specified identifier, including the
|
||||
most up-to-date status information for the session.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -399,7 +580,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSession.keep_alive">
|
||||
<code class="descname">keep_alive</code><span class="sig-paren">(</span><em>download_session_id</em>, <em>progress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.keep_alive" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">keep_alive</code><span class="sig-paren">(</span><em class="sig-param">download_session_id</em>, <em class="sig-param">progress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.keep_alive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Keeps a download session alive. This operation is allowed only if the
|
||||
session is in the <a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.State.ACTIVE</span></code></a> state.</p>
|
||||
<p>If there is no activity for a download session for a certain period of
|
||||
@ -442,7 +623,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSession.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>library_item_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">library_item_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lists the identifiers of the download sessions created by the calling
|
||||
user. Optionally may filter by library item.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -482,7 +663,7 @@ referenced by the parameter <code class="docutils literal notranslate"><span cla
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSessionModel">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">DownloadSessionModel</code><span class="sig-paren">(</span><em>id=None</em>, <em>library_item_id=None</em>, <em>library_item_content_version=None</em>, <em>error_message=None</em>, <em>client_progress=None</em>, <em>state=None</em>, <em>expiration_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item_client.</code><code class="sig-name descname">DownloadSessionModel</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">library_item_id=None</em>, <em class="sig-param">library_item_content_version=None</em>, <em class="sig-param">error_message=None</em>, <em class="sig-param">client_progress=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">expiration_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel" 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">DownloadSessionModel</span></code> class provides information on an active
|
||||
<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSession" title="com.vmware.content.library.item_client.DownloadSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">DownloadSession</span></code></a> resource.</p>
|
||||
@ -549,7 +730,7 @@ methods. It is not used for the <code class="docutils literal notranslate"><span
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State">
|
||||
<em class="property">class </em><code class="descname">State</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State" 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 state of the download session.</p>
|
||||
<div class="admonition note">
|
||||
@ -569,14 +750,14 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE">
|
||||
<code class="descname">ACTIVE</code><em class="property"> = State(string='ACTIVE')</em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">ACTIVE</code><em class="property"> = State(string='ACTIVE')</em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The session is active. Individual files may be in the process of being
|
||||
transferred and may become ready for download at different times.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State.CANCELED">
|
||||
<code class="descname">CANCELED</code><em class="property"> = State(string='CANCELED')</em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.CANCELED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">CANCELED</code><em class="property"> = State(string='CANCELED')</em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.CANCELED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The session has been canceled. On-going downloads may fail. The session
|
||||
will stay in this state until it is either deleted by the user or
|
||||
automatically cleaned up by the Content Library Service.</p>
|
||||
@ -584,7 +765,7 @@ automatically cleaned up by the Content Library Service.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR">
|
||||
<code class="descname">ERROR</code><em class="property"> = State(string='ERROR')</em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">ERROR</code><em class="property"> = State(string='ERROR')</em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates there was an error during the session lifecycle.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -594,7 +775,7 @@ automatically cleaned up by the Content Library Service.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.File">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">File</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item_client.</code><code class="sig-name descname">File</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File" 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">File</span></code> class can be used to query for information on the files within
|
||||
a library item. Files are objects which are added to a library item through
|
||||
@ -607,7 +788,7 @@ the <a class="reference internal" href="#com.vmware.content.library.item_client.
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm">
|
||||
<em class="property">class </em><code class="descname">ChecksumAlgorithm</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">ChecksumAlgorithm</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm" 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">File.ChecksumAlgorithm</span></code> class defines the valid checksum algorithms.</p>
|
||||
<div class="admonition note">
|
||||
@ -627,26 +808,26 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm.MD5">
|
||||
<code class="descname">MD5</code><em class="property"> = ChecksumAlgorithm(string='MD5')</em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.MD5" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">MD5</code><em class="property"> = ChecksumAlgorithm(string='MD5')</em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.MD5" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checksum algorithm: MD5</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA1">
|
||||
<code class="descname">SHA1</code><em class="property"> = ChecksumAlgorithm(string='SHA1')</em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA1" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SHA1</code><em class="property"> = ChecksumAlgorithm(string='SHA1')</em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA1" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checksum algorithm: SHA-1</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA256">
|
||||
<code class="descname">SHA256</code><em class="property"> = ChecksumAlgorithm(string='SHA256')</em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA256" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SHA256</code><em class="property"> = ChecksumAlgorithm(string='SHA256')</em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA256" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checksum algorithm: SHA-256. This class attribute was added in vSphere API
|
||||
6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA512">
|
||||
<code class="descname">SHA512</code><em class="property"> = ChecksumAlgorithm(string='SHA512')</em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA512" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SHA512</code><em class="property"> = ChecksumAlgorithm(string='SHA512')</em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA512" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checksum algorithm: SHA-512. This class attribute was added in vSphere API
|
||||
6.8.</p>
|
||||
</dd></dl>
|
||||
@ -655,7 +836,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.File.ChecksumInfo">
|
||||
<em class="property">class </em><code class="descname">ChecksumInfo</code><span class="sig-paren">(</span><em>algorithm=None</em>, <em>checksum=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">ChecksumInfo</code><span class="sig-paren">(</span><em class="sig-param">algorithm=None</em>, <em class="sig-param">checksum=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumInfo" 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 checksums for a <a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a> object.</p>
|
||||
<div class="admonition tip">
|
||||
@ -679,7 +860,7 @@ If not specified the default checksum algorithm is
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.File.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>checksum_info=None</em>, <em>name=None</em>, <em>size=None</em>, <em>cached=None</em>, <em>version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">checksum_info=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">size=None</em>, <em class="sig-param">cached=None</em>, <em class="sig-param">version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.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">File.Info</span></code> class provides information about a file in Content
|
||||
Library Service storage.</p>
|
||||
@ -718,7 +899,7 @@ is uploaded.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.File.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>library_item_id</em>, <em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">library_item_id</em>, <em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves the information for a single file in a library item by its
|
||||
name.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -762,7 +943,7 @@ the parameter <code class="docutils literal notranslate"><span class="pre">libra
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.File.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>library_item_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">library_item_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lists all of the files that are stored within a given library item.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -797,7 +978,7 @@ the parameter <code class="docutils literal notranslate"><span class="pre">libra
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.Storage">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">Storage</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item_client.</code><code class="sig-name descname">Storage</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage" 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><code class="docutils literal notranslate"><span class="pre">Storage</span></code> is a resource that represents a specific instance of a file
|
||||
stored on a storage backing. Unlike <a class="reference internal" href="#com.vmware.content.library.item_client.File" title="com.vmware.content.library.item_client.File"><code class="xref py py-class docutils literal notranslate"><span class="pre">File</span></code></a>, which is abstract,
|
||||
@ -814,7 +995,7 @@ file on the storage medium.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.Storage.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>storage_backing=None</em>, <em>storage_uris=None</em>, <em>checksum_info=None</em>, <em>name=None</em>, <em>size=None</em>, <em>cached=None</em>, <em>version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">storage_backing=None</em>, <em class="sig-param">storage_uris=None</em>, <em class="sig-param">checksum_info=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">size=None</em>, <em class="sig-param">cached=None</em>, <em class="sig-param">version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage.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">Storage.Info</span></code> class is the expanded form of <a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a> that
|
||||
includes details about the storage backing for a file in a library item.</p>
|
||||
@ -861,7 +1042,7 @@ is uploaded.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.Storage.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>library_item_id</em>, <em>file_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">library_item_id</em>, <em class="sig-param">file_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves the storage information for a specific file in a library
|
||||
item.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -904,7 +1085,7 @@ the parameter <code class="docutils literal notranslate"><span class="pre">libra
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.Storage.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>library_item_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">library_item_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lists all storage items for a given library item.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -939,7 +1120,7 @@ the parameter <code class="docutils literal notranslate"><span class="pre">libra
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_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.library.item_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_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">
|
||||
@ -951,7 +1132,7 @@ the parameter <code class="docutils literal notranslate"><span class="pre">libra
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.TransferEndpoint">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">TransferEndpoint</code><span class="sig-paren">(</span><em>uri=None</em>, <em>ssl_certificate_thumbprint=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.TransferEndpoint" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item_client.</code><code class="sig-name descname">TransferEndpoint</code><span class="sig-paren">(</span><em class="sig-param">uri=None</em>, <em class="sig-param">ssl_certificate_thumbprint=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.TransferEndpoint" 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">TransferEndpoint</span></code> class encapsulates a URI along with extra
|
||||
information about it.</p>
|
||||
@ -995,7 +1176,7 @@ If not specified, standard certificate validation is performed.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.TransferStatus">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">TransferStatus</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item_client.</code><code class="sig-name descname">TransferStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus" 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">TransferStatus</span></code> class defines the transfer state of a file.</p>
|
||||
<div class="admonition note">
|
||||
@ -1015,31 +1196,31 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.TransferStatus.ERROR">
|
||||
<code class="descname">ERROR</code><em class="property"> = TransferStatus(string='ERROR')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">ERROR</code><em class="property"> = TransferStatus(string='ERROR')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that there was an error transferring or validating the file.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.TransferStatus.READY">
|
||||
<code class="descname">READY</code><em class="property"> = TransferStatus(string='READY')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.READY" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">READY</code><em class="property"> = TransferStatus(string='READY')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.READY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the file has been fully transferred and is ready to be used.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.TransferStatus.TRANSFERRING">
|
||||
<code class="descname">TRANSFERRING</code><em class="property"> = TransferStatus(string='TRANSFERRING')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.TRANSFERRING" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">TRANSFERRING</code><em class="property"> = TransferStatus(string='TRANSFERRING')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.TRANSFERRING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that data is being transferred to the file.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.TransferStatus.VALIDATING">
|
||||
<code class="descname">VALIDATING</code><em class="property"> = TransferStatus(string='VALIDATING')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.VALIDATING" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">VALIDATING</code><em class="property"> = TransferStatus(string='VALIDATING')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.VALIDATING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the file is being validated (checksum, type adapters).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.TransferStatus.WAITING_FOR_TRANSFER">
|
||||
<code class="descname">WAITING_FOR_TRANSFER</code><em class="property"> = TransferStatus(string='WAITING_FOR_TRANSFER')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.WAITING_FOR_TRANSFER" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">WAITING_FOR_TRANSFER</code><em class="property"> = TransferStatus(string='WAITING_FOR_TRANSFER')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.WAITING_FOR_TRANSFER" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that a file has been defined for a library item and its content
|
||||
needs to be uploaded.</p>
|
||||
</dd></dl>
|
||||
@ -1048,7 +1229,7 @@ needs to be uploaded.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSession">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">UpdateSession</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item_client.</code><code class="sig-name descname">UpdateSession</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession" 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">UpdateSession</span></code> class manipulates sessions that are used to upload
|
||||
content into the Content Library Service, and/or to remove files from a
|
||||
@ -1071,13 +1252,13 @@ completed and all necessary files have been received.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSession.RESOURCE_TYPE">
|
||||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.library.item.UpdateSession'</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.library.item.UpdateSession'</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for an update session.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSession.cancel">
|
||||
<code class="descname">cancel</code><span class="sig-paren">(</span><em>update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.cancel" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">cancel</code><span class="sig-paren">(</span><em class="sig-param">update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.cancel" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cancels the update session and sets its state to
|
||||
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED" title="com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.CANCELED</span></code></a>. This method will free up any
|
||||
temporary resources currently associated with the session.</p>
|
||||
@ -1114,7 +1295,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSession.complete">
|
||||
<code class="descname">complete</code><span class="sig-paren">(</span><em>update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.complete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">complete</code><span class="sig-paren">(</span><em class="sig-param">update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.complete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Completes the update session. This indicates that the client has
|
||||
finished making all the changes required to the underlying library
|
||||
item. If the client is pushing the content to the server, the library
|
||||
@ -1161,7 +1342,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSession.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>create_spec</em>, <em>client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">create_spec</em>, <em class="sig-param">client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a new update session. An update session is used to make
|
||||
modifications to a library item. Modifications are not visible to other
|
||||
clients unless the session is completed and all necessary files have
|
||||
@ -1222,7 +1403,7 @@ the attribute <code class="xref py py-attr docutils literal notranslate"><span c
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSession.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes an update session. This removes the session and all information
|
||||
associated with it.</p>
|
||||
<p>Removing an update session leaves any current transfers for that
|
||||
@ -1260,7 +1441,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSession.fail">
|
||||
<code class="descname">fail</code><span class="sig-paren">(</span><em>update_session_id</em>, <em>client_error_message</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.fail" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">fail</code><span class="sig-paren">(</span><em class="sig-param">update_session_id</em>, <em class="sig-param">client_error_message</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Terminates the update session with a client specified error message.</p>
|
||||
<p>This is useful in transmitting client side failures (for example, not
|
||||
being able to access a file) to the server side.</p>
|
||||
@ -1296,7 +1477,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSession.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets the update session with the specified identifier, including the
|
||||
most up-to-date status information for the session.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -1328,7 +1509,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSession.keep_alive">
|
||||
<code class="descname">keep_alive</code><span class="sig-paren">(</span><em>update_session_id</em>, <em>client_progress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.keep_alive" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">keep_alive</code><span class="sig-paren">(</span><em class="sig-param">update_session_id</em>, <em class="sig-param">client_progress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.keep_alive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Keeps an update session alive.</p>
|
||||
<p>If there is no activity for an update session after a period of time,
|
||||
the update session will expire, then be deleted. The update session
|
||||
@ -1369,7 +1550,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSession.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>library_item_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">library_item_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lists the identifiers of the update session created by the calling
|
||||
user. Optionally may filter by library item.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -1407,7 +1588,7 @@ referenced by the parameter <code class="docutils literal notranslate"><span cla
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSession.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>update_session_id</em>, <em>update_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.update" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">update_session_id</em>, <em class="sig-param">update_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Updates the properties of an update session.</p>
|
||||
<p>This is an incremental update to the update session. Any attribute in
|
||||
the <a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel" title="com.vmware.content.library.item_client.UpdateSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSessionModel</span></code></a> class that is None will not be
|
||||
@ -1457,7 +1638,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSessionModel">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">UpdateSessionModel</code><span class="sig-paren">(</span><em>id=None</em>, <em>library_item_id=None</em>, <em>library_item_content_version=None</em>, <em>error_message=None</em>, <em>client_progress=None</em>, <em>state=None</em>, <em>expiration_time=None</em>, <em>preview_info=None</em>, <em>warning_behavior=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item_client.</code><code class="sig-name descname">UpdateSessionModel</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">library_item_id=None</em>, <em class="sig-param">library_item_content_version=None</em>, <em class="sig-param">error_message=None</em>, <em class="sig-param">client_progress=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">expiration_time=None</em>, <em class="sig-param">preview_info=None</em>, <em class="sig-param">warning_behavior=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel" 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">UpdateSessionModel</span></code> class provides information on an active
|
||||
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSession" title="com.vmware.content.library.item_client.UpdateSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSession</span></code></a> resource.</p>
|
||||
@ -1537,7 +1718,7 @@ is optional for the <code class="docutils literal notranslate"><span class="pre"
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State">
|
||||
<em class="property">class </em><code class="descname">State</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State" 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 state of an update session.</p>
|
||||
<div class="admonition note">
|
||||
@ -1557,7 +1738,7 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE">
|
||||
<code class="descname">ACTIVE</code><em class="property"> = State(string='ACTIVE')</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">ACTIVE</code><em class="property"> = State(string='ACTIVE')</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The session is currently active. This is the initial state when the session
|
||||
is created. Files may be uploaded by the client or pulled by the Content
|
||||
Library Service at this stage.</p>
|
||||
@ -1565,19 +1746,19 @@ Library Service at this stage.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED">
|
||||
<code class="descname">CANCELED</code><em class="property"> = State(string='CANCELED')</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">CANCELED</code><em class="property"> = State(string='CANCELED')</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The session has been canceled.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.DONE">
|
||||
<code class="descname">DONE</code><em class="property"> = State(string='DONE')</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.DONE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">DONE</code><em class="property"> = State(string='DONE')</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.DONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The session is done and all its effects are now visible.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR">
|
||||
<code class="descname">ERROR</code><em class="property"> = State(string='ERROR')</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">ERROR</code><em class="property"> = State(string='ERROR')</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>There was an error during the session.</p>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.content.library.item package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
<title>com.vmware.content.library.item package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,7 +186,7 @@
|
||||
for downloading files in a session.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item.downloadsession_client.</code><code class="descname">File</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item.downloadsession_client.</code><code class="sig-name descname">File</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File" 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">File</span></code> class provides methods for accessing files within a download
|
||||
session.</p>
|
||||
@ -205,7 +205,7 @@ for the file status to become <a class="reference internal" href="#com.vmware.co
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.EndpointType">
|
||||
<em class="property">class </em><code class="descname">EndpointType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">EndpointType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType" 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">File.EndpointType</span></code> class defines the types of endpoints used to
|
||||
download the file.</p>
|
||||
@ -226,7 +226,7 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.EndpointType.DIRECT">
|
||||
<code class="descname">DIRECT</code><em class="property"> = EndpointType(string='DIRECT')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.DIRECT" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">DIRECT</code><em class="property"> = EndpointType(string='DIRECT')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.DIRECT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A direct download endpoint indicating the location of the file on storage.
|
||||
The caller is responsible for retrieving the file from the storage location
|
||||
directly.</p>
|
||||
@ -234,7 +234,7 @@ directly.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.EndpointType.HTTPS">
|
||||
<code class="descname">HTTPS</code><em class="property"> = EndpointType(string='HTTPS')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.HTTPS" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">HTTPS</code><em class="property"> = EndpointType(string='HTTPS')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.HTTPS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>An https download endpoint.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -242,7 +242,7 @@ directly.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>name=None</em>, <em>size=None</em>, <em>bytes_transferred=None</em>, <em>status=None</em>, <em>download_endpoint=None</em>, <em>checksum_info=None</em>, <em>error_message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">size=None</em>, <em class="sig-param">bytes_transferred=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">download_endpoint=None</em>, <em class="sig-param">checksum_info=None</em>, <em class="sig-param">error_message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.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">File.Info</span></code> class defines the downloaded file.</p>
|
||||
<div class="admonition tip">
|
||||
@ -283,7 +283,7 @@ transfer.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus">
|
||||
<em class="property">class </em><code class="descname">PrepareStatus</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">PrepareStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus" 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">File.PrepareStatus</span></code> class defines the state of the file in
|
||||
preparation for download.</p>
|
||||
@ -304,33 +304,33 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.ERROR">
|
||||
<code class="descname">ERROR</code><em class="property"> = PrepareStatus(string='ERROR')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">ERROR</code><em class="property"> = PrepareStatus(string='ERROR')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prepare failed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED">
|
||||
<code class="descname">PREPARED</code><em class="property"> = PrepareStatus(string='PREPARED')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">PREPARED</code><em class="property"> = PrepareStatus(string='PREPARED')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prepare succeeded. The file is ready for download.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARE_REQUESTED">
|
||||
<code class="descname">PREPARE_REQUESTED</code><em class="property"> = PrepareStatus(string='PREPARE_REQUESTED')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARE_REQUESTED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">PREPARE_REQUESTED</code><em class="property"> = PrepareStatus(string='PREPARE_REQUESTED')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARE_REQUESTED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A prepare has been requested, however the server hasn’t started the
|
||||
preparation yet.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARING">
|
||||
<code class="descname">PREPARING</code><em class="property"> = PrepareStatus(string='PREPARING')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARING" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">PREPARING</code><em class="property"> = PrepareStatus(string='PREPARING')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A prepare has been requested and the file is in the process of being
|
||||
prepared.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.UNPREPARED">
|
||||
<code class="descname">UNPREPARED</code><em class="property"> = PrepareStatus(string='UNPREPARED')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.UNPREPARED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">UNPREPARED</code><em class="property"> = PrepareStatus(string='UNPREPARED')</em><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.UNPREPARED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The file hasn’t been requested for preparation.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -338,7 +338,7 @@ prepared.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>download_session_id</em>, <em>file_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">download_session_id</em>, <em class="sig-param">file_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves file download information for a specific file.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -377,7 +377,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>download_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">download_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lists the information of all the files in the library item associated
|
||||
with the download session.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -409,7 +409,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.File.prepare">
|
||||
<code class="descname">prepare</code><span class="sig-paren">(</span><em>download_session_id</em>, <em>file_name</em>, <em>endpoint_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.prepare" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">prepare</code><span class="sig-paren">(</span><em class="sig-param">download_session_id</em>, <em class="sig-param">file_name</em>, <em class="sig-param">endpoint_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_client.File.prepare" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Requests a file to be prepared for download.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -461,7 +461,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.downloadsession_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item.downloadsession_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.library.item.downloadsession_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item.downloadsession_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.downloadsession_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">
|
||||
@ -478,7 +478,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
updating files in a session.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.CertificateInfo">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="descname">CertificateInfo</code><span class="sig-paren">(</span><em>issuer=None</em>, <em>subject=None</em>, <em>self_signed=None</em>, <em>x509=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.CertificateInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="sig-name descname">CertificateInfo</code><span class="sig-paren">(</span><em class="sig-param">issuer=None</em>, <em class="sig-param">subject=None</em>, <em class="sig-param">self_signed=None</em>, <em class="sig-param">x509=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.CertificateInfo" 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">CertificateInfo</span></code> class contains information about the public key
|
||||
certificate used to sign the content. This class was added in vSphere API
|
||||
@ -508,7 +508,7 @@ added in vSphere API 6.8.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="descname">File</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="sig-name descname">File</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File" 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">File</span></code> class provides methods for accessing files within an update
|
||||
session.</p>
|
||||
@ -531,7 +531,7 @@ completed. See
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.AddSpec">
|
||||
<em class="property">class </em><code class="descname">AddSpec</code><span class="sig-paren">(</span><em>name=None</em>, <em>source_type=None</em>, <em>source_endpoint=None</em>, <em>size=None</em>, <em>checksum_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.AddSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">AddSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">source_type=None</em>, <em class="sig-param">source_endpoint=None</em>, <em class="sig-param">size=None</em>, <em class="sig-param">checksum_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.AddSpec" 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">File.AddSpec</span></code> class describes the properties of the file to be
|
||||
uploaded.</p>
|
||||
@ -563,7 +563,7 @@ If None, the server will not verify the checksum.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>name=None</em>, <em>source_type=None</em>, <em>size=None</em>, <em>checksum_info=None</em>, <em>source_endpoint=None</em>, <em>upload_endpoint=None</em>, <em>bytes_transferred=None</em>, <em>status=None</em>, <em>error_message=None</em>, <em>keep_in_storage=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">source_type=None</em>, <em class="sig-param">size=None</em>, <em class="sig-param">checksum_info=None</em>, <em class="sig-param">source_endpoint=None</em>, <em class="sig-param">upload_endpoint=None</em>, <em class="sig-param">bytes_transferred=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">error_message=None</em>, <em class="sig-param">keep_in_storage=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.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">File.Info</span></code> class defines the uploaded file.</p>
|
||||
<div class="admonition tip">
|
||||
@ -616,7 +616,7 @@ completion.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.SourceType">
|
||||
<em class="property">class </em><code class="descname">SourceType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.SourceType" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">SourceType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.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">File.SourceType</span></code> class defines how the file content is retrieved.</p>
|
||||
<div class="admonition note">
|
||||
@ -636,20 +636,20 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.SourceType.NONE">
|
||||
<code class="descname">NONE</code><em class="property"> = SourceType(string='NONE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NONE</code><em class="property"> = SourceType(string='NONE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>No source type has been requested.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.SourceType.PULL">
|
||||
<code class="descname">PULL</code><em class="property"> = SourceType(string='PULL')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PULL" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">PULL</code><em class="property"> = SourceType(string='PULL')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PULL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The server is pulling content from a URL. The URL scheme can be <code class="docutils literal notranslate"><span class="pre">http</span></code>,
|
||||
<code class="docutils literal notranslate"><span class="pre">https</span></code>, <code class="docutils literal notranslate"><span class="pre">file</span></code>, or <code class="docutils literal notranslate"><span class="pre">ds</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.SourceType.PUSH">
|
||||
<code class="descname">PUSH</code><em class="property"> = SourceType(string='PUSH')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PUSH" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">PUSH</code><em class="property"> = SourceType(string='PUSH')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PUSH" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The client is uploading content using HTTP(S) PUT requests.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -657,7 +657,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.ValidationError">
|
||||
<em class="property">class </em><code class="descname">ValidationError</code><span class="sig-paren">(</span><em>name=None</em>, <em>error_message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.ValidationError" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">ValidationError</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">error_message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.ValidationError" 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">File.ValidationError</span></code> class defines the validation error of a file
|
||||
in the session.</p>
|
||||
@ -678,7 +678,7 @@ names.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.ValidationResult">
|
||||
<em class="property">class </em><code class="descname">ValidationResult</code><span class="sig-paren">(</span><em>has_errors=None</em>, <em>missing_files=None</em>, <em>invalid_files=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.ValidationResult" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">ValidationResult</code><span class="sig-paren">(</span><em class="sig-param">has_errors=None</em>, <em class="sig-param">missing_files=None</em>, <em class="sig-param">invalid_files=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.ValidationResult" 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">File.ValidationResult</span></code> class defines the result of validating the
|
||||
files in the session.</p>
|
||||
@ -705,7 +705,7 @@ invalid and details about the error.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.add">
|
||||
<code class="descname">add</code><span class="sig-paren">(</span><em>update_session_id</em>, <em>file_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.add" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">update_session_id</em>, <em class="sig-param">file_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Requests file content to be changed (either created, or updated).
|
||||
Depending on the source type of the file, this method will either
|
||||
return an upload endpoint where the client can push the content, or the
|
||||
@ -777,7 +777,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>update_session_id</em>, <em>file_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">update_session_id</em>, <em class="sig-param">file_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves information about a specific file in the snapshot of the
|
||||
library item at the time when the update session was created.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -816,7 +816,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lists all files in the library item associated with the update session.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -850,7 +850,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.remove">
|
||||
<code class="descname">remove</code><span class="sig-paren">(</span><em>update_session_id</em>, <em>file_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">update_session_id</em>, <em class="sig-param">file_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Requests a file to be removed. The file will only be effectively
|
||||
removed when the update session is completed.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -883,7 +883,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.File.validate">
|
||||
<code class="descname">validate</code><span class="sig-paren">(</span><em>update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.validate" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">validate</code><span class="sig-paren">(</span><em class="sig-param">update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.File.validate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Validates the files in the update session with the referenced
|
||||
identifier and ensures all necessary files are received. In the case
|
||||
where a file is missing, this method will return its name in the
|
||||
@ -929,7 +929,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewInfo">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="descname">PreviewInfo</code><span class="sig-paren">(</span><em>state=None</em>, <em>certificate_info=None</em>, <em>warnings=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="sig-name descname">PreviewInfo</code><span class="sig-paren">(</span><em class="sig-param">state=None</em>, <em class="sig-param">certificate_info=None</em>, <em class="sig-param">warnings=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo" 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">PreviewInfo</span></code> class contains information about the files being
|
||||
uploaded in the update session. This class was added in vSphere API 6.8.</p>
|
||||
@ -957,7 +957,7 @@ of <code class="docutils literal notranslate"><span class="pre">state</span></co
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewInfo.State">
|
||||
<em class="property">class </em><code class="descname">State</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State" 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">PreviewInfo.State</span></code> class defines the state of the update session’s
|
||||
preview. This enumeration was added in vSphere API 6.8.</p>
|
||||
@ -978,7 +978,7 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewInfo.State.AVAILABLE">
|
||||
<code class="descname">AVAILABLE</code><em class="property"> = State(string='AVAILABLE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.AVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">AVAILABLE</code><em class="property"> = State(string='AVAILABLE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.AVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Preview is available for this update session. It is possible to review
|
||||
certificate details and warnings, if any. This state is reached when the
|
||||
applicable metadata files in the session have been fully uploaded. This
|
||||
@ -987,7 +987,7 @@ class attribute was added in vSphere API 6.8.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewInfo.State.NOT_APPLICABLE">
|
||||
<code class="descname">NOT_APPLICABLE</code><em class="property"> = State(string='NOT_APPLICABLE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.NOT_APPLICABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NOT_APPLICABLE</code><em class="property"> = State(string='NOT_APPLICABLE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.NOT_APPLICABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Preview is not possible for this update session. This state is reached when
|
||||
there are no metadata files in the update session and user invokes a
|
||||
session complete operation. This class attribute was added in vSphere API
|
||||
@ -996,7 +996,7 @@ session complete operation. This class attribute was added in vSphere API
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewInfo.State.PREPARING">
|
||||
<code class="descname">PREPARING</code><em class="property"> = State(string='PREPARING')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.PREPARING" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">PREPARING</code><em class="property"> = State(string='PREPARING')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.PREPARING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A preview is being prepared for the files currently in the update session.
|
||||
This state is reached when the applicable metadata files are added to the
|
||||
update session but their content is not fully uploaded yet. For OVF item
|
||||
@ -1006,7 +1006,7 @@ uploaded. This class attribute was added in vSphere API 6.8.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewInfo.State.UNAVAILABLE">
|
||||
<code class="descname">UNAVAILABLE</code><em class="property"> = State(string='UNAVAILABLE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">UNAVAILABLE</code><em class="property"> = State(string='UNAVAILABLE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>There are no files in the update session OR a preview is not possible for
|
||||
the files currently in the update session. However, preview may be possible
|
||||
after metadata files such as OVF descriptor are added to the session. In
|
||||
@ -1020,7 +1020,7 @@ was added in vSphere API 6.8.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.PreviewWarningInfo">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="descname">PreviewWarningInfo</code><span class="sig-paren">(</span><em>type=None</em>, <em>message=None</em>, <em>ignored=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewWarningInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="sig-name descname">PreviewWarningInfo</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">message=None</em>, <em class="sig-param">ignored=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.PreviewWarningInfo" 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">PreviewWarningInfo</span></code> class provides information about the warnings
|
||||
which are raised during the update session preview. This class was added in
|
||||
@ -1046,7 +1046,7 @@ operation. This attribute was added in vSphere API 6.8.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item.updatesession_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.library.item.updatesession_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_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">
|
||||
@ -1058,7 +1058,7 @@ operation. This attribute was added in vSphere API 6.8.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.WarningBehavior">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="descname">WarningBehavior</code><span class="sig-paren">(</span><em>type=None</em>, <em>ignored=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningBehavior" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="sig-name descname">WarningBehavior</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">ignored=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningBehavior" 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">WarningBehavior</span></code> class defines the session behavior if the warning
|
||||
is raised during the update session. This class was added in vSphere API
|
||||
@ -1082,7 +1082,7 @@ operation. This attribute was added in vSphere API 6.8.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.WarningType">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="descname">WarningType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><code class="sig-name descname">WarningType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType" 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">WarningType</span></code> class defines the warnings which can be raised during
|
||||
the update session. This enumeration was added in vSphere API 6.8.</p>
|
||||
@ -1103,28 +1103,28 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.WarningType.EXPIRED_CERTIFICATE">
|
||||
<code class="descname">EXPIRED_CERTIFICATE</code><em class="property"> = WarningType(string='EXPIRED_CERTIFICATE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType.EXPIRED_CERTIFICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">EXPIRED_CERTIFICATE</code><em class="property"> = WarningType(string='EXPIRED_CERTIFICATE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType.EXPIRED_CERTIFICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The certificate used for signing the content is expired. This class
|
||||
attribute was added in vSphere API 6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.WarningType.NOT_YET_VALID_CERTIFICATE">
|
||||
<code class="descname">NOT_YET_VALID_CERTIFICATE</code><em class="property"> = WarningType(string='NOT_YET_VALID_CERTIFICATE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType.NOT_YET_VALID_CERTIFICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NOT_YET_VALID_CERTIFICATE</code><em class="property"> = WarningType(string='NOT_YET_VALID_CERTIFICATE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType.NOT_YET_VALID_CERTIFICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The certificate used for signing the content is not yet valid. This class
|
||||
attribute was added in vSphere API 6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.WarningType.SELF_SIGNED_CERTIFICATE">
|
||||
<code class="descname">SELF_SIGNED_CERTIFICATE</code><em class="property"> = WarningType(string='SELF_SIGNED_CERTIFICATE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType.SELF_SIGNED_CERTIFICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SELF_SIGNED_CERTIFICATE</code><em class="property"> = WarningType(string='SELF_SIGNED_CERTIFICATE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType.SELF_SIGNED_CERTIFICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The certificate used for signing the content is self-signed. This class
|
||||
attribute was added in vSphere API 6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.content.library.item.updatesession_client.WarningType.UNTRUSTED_CERTIFICATE">
|
||||
<code class="descname">UNTRUSTED_CERTIFICATE</code><em class="property"> = WarningType(string='UNTRUSTED_CERTIFICATE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType.UNTRUSTED_CERTIFICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">UNTRUSTED_CERTIFICATE</code><em class="property"> = WarningType(string='UNTRUSTED_CERTIFICATE')</em><a class="headerlink" href="#com.vmware.content.library.item.updatesession_client.WarningType.UNTRUSTED_CERTIFICATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The certificate used for signing the content is not trusted. This class
|
||||
attribute was added in vSphere API 6.8.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<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>
|
||||
<title>com.vmware.content.type package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -194,7 +194,7 @@
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">Cpu</code><span class="sig-paren">(</span><em class="sig-param">num_cpus=None</em>, <em class="sig-param">reservation=None</em>, <em class="sig-param">limit=None</em>, <em class="sig-param">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">
|
||||
@ -219,7 +219,7 @@ It is optional to specify CPU shares.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">Disk</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">disk_capacity=None</em>, <em class="sig-param">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">
|
||||
@ -243,7 +243,7 @@ It is not required that storage policy be specified.</p>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">DiskController</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">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">
|
||||
@ -266,7 +266,7 @@ It is optional to specify a disk controller subtype.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">Drive</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">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">
|
||||
@ -289,7 +289,7 @@ It is optional to specify a drive subtype.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">Floppy</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">connected=None</em>, <em class="sig-param">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">
|
||||
@ -312,7 +312,7 @@ It is optional to specify the type of floppy drive.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">Memory</code><span class="sig-paren">(</span><em class="sig-param">size=None</em>, <em class="sig-param">reservation=None</em>, <em class="sig-param">limit=None</em>, <em class="sig-param">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">
|
||||
@ -337,7 +337,7 @@ It is not required that memory shares be specified.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">Network</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">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">
|
||||
@ -358,7 +358,7 @@ Networks do not require a description.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">Nic</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">network_name=None</em>, <em class="sig-param">mac_address=None</em>, <em class="sig-param">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">
|
||||
@ -383,7 +383,7 @@ It is not required that whether the NIC is connected be specified.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">OvfTemplate</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">vm_count=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">library_id_parent=None</em>, <em class="sig-param">is_vapp_template=None</em>, <em class="sig-param">vm_template=None</em>, <em class="sig-param">vapp_template=None</em>, <em class="sig-param">networks=None</em>, <em class="sig-param">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
|
||||
@ -435,7 +435,7 @@ An OVF template does not require policies.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">
|
||||
@ -447,7 +447,7 @@ An OVF template does not require policies.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">USBController</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">auto_connect=None</em>, <em class="sig-param">ehci_pci_slot_number=None</em>, <em class="sig-param">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">
|
||||
@ -473,7 +473,7 @@ A template is not required to specify the pci slot number.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">VAppTemplate</code><span class="sig-paren">(</span><em class="sig-param">vapp_name=None</em>, <em class="sig-param">vm_templates=None</em>, <em class="sig-param">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">
|
||||
@ -497,7 +497,7 @@ vApp templates do not require a list of storage policies.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">VideoCard</code><span class="sig-paren">(</span><em class="sig-param">render_type=None</em>, <em class="sig-param">video_ram_size=None</em>, <em class="sig-param">graphics_memory_size=None</em>, <em class="sig-param">enable3d=None</em>, <em class="sig-param">num_displays=None</em>, <em class="sig-param">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">
|
||||
@ -528,7 +528,7 @@ A template is not required to specify use auto dectect.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf_client.</code><code class="sig-name descname">VmTemplate</code><span class="sig-paren">(</span><em class="sig-param">vm_name=None</em>, <em class="sig-param">os_type=None</em>, <em class="sig-param">os_description=None</em>, <em class="sig-param">cpu=None</em>, <em class="sig-param">memory=None</em>, <em class="sig-param">disks=None</em>, <em class="sig-param">nics=None</em>, <em class="sig-param">video_cards=None</em>, <em class="sig-param">drives=None</em>, <em class="sig-param">floppies=None</em>, <em class="sig-param">disk_controllers=None</em>, <em class="sig-param">usb_controllers=None</em>, <em class="sig-param">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,
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<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>
|
||||
<title>com.vmware.content.type.ovf package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -184,7 +184,7 @@
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf.policy_client.</code><code class="sig-name descname">StoragePolicy</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -202,7 +202,7 @@ names.</p>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf.policy_client.</code><code class="sig-name descname">StoragePolicyGroup</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">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>
|
||||
@ -225,7 +225,7 @@ Description is not required.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.content.type.ovf.policy_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">
|
||||
|
||||
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.7 documentation</title>
|
||||
<title>com.vmware.vapi package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -207,6 +207,7 @@
|
||||
<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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.interposition_client">com.vmware.vapi.std.interposition_client module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -228,7 +229,7 @@ etc.</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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata_client.</code><code class="sig-name descname">SourceCreateSpec</code><span class="sig-paren">(</span><em class="sig-param">description=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">filepath=None</em>, <em class="sig-param">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>
|
||||
@ -261,7 +262,7 @@ of <code class="docutils literal notranslate"><span class="pre">type</span></cod
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata_client.</code><code class="sig-name descname">SourceInfo</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">file_name=None</em>, <em class="sig-param">remote_addr=None</em>, <em class="sig-param">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">
|
||||
@ -289,7 +290,7 @@ of <code class="docutils literal notranslate"><span class="pre">type</span></cod
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata_client.</code><code class="sig-name descname">SourceType</code><span class="sig-paren">(</span><em class="sig-param">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
|
||||
@ -311,13 +312,13 @@ type description page</span></a>.</p>
|
||||
</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>
|
||||
<code class="sig-name 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>
|
||||
<code class="sig-name 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>
|
||||
|
||||
@ -325,7 +326,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">
|
||||
@ -342,7 +343,7 @@ type description page</span></a>.</p>
|
||||
used in the interface specification of any class.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.std_client.</code><code class="descname">AuthenticationScheme</code><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std_client.</code><code class="sig-name descname">AuthenticationScheme</code><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme" 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 <a class="reference internal" href="#com.vmware.vapi.std_client.AuthenticationScheme" title="com.vmware.vapi.std_client.AuthenticationScheme"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuthenticationScheme</span></code></a> class defines constants for
|
||||
authentication scheme identifiers for authentication mechanisms present in
|
||||
@ -356,13 +357,13 @@ names.</p>
|
||||
</div>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.NO_AUTHENTICATION">
|
||||
<code class="descname">NO_AUTHENTICATION</code><em class="property"> = 'com.vmware.vapi.std.security.no_authentication'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.NO_AUTHENTICATION" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NO_AUTHENTICATION</code><em class="property"> = 'com.vmware.vapi.std.security.no_authentication'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.NO_AUTHENTICATION" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the request doesn’t need any authentication.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.OAUTH_ACCESS_TOKEN">
|
||||
<code class="descname">OAUTH_ACCESS_TOKEN</code><em class="property"> = 'com.vmware.vapi.std.security.oauth'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.OAUTH_ACCESS_TOKEN" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">OAUTH_ACCESS_TOKEN</code><em class="property"> = 'com.vmware.vapi.std.security.oauth'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.OAUTH_ACCESS_TOKEN" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the security context in a request is using OAuth2 based
|
||||
authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
@ -385,7 +386,7 @@ format.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.SAML_BEARER_TOKEN">
|
||||
<code class="descname">SAML_BEARER_TOKEN</code><em class="property"> = 'com.vmware.vapi.std.security.saml_bearer_token'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.SAML_BEARER_TOKEN" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SAML_BEARER_TOKEN</code><em class="property"> = 'com.vmware.vapi.std.security.saml_bearer_token'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.SAML_BEARER_TOKEN" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the security context in a request is using a SAML bearer token
|
||||
based authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
@ -405,7 +406,7 @@ and to create the security context that conforms to the above mentioned format.<
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.SAML_HOK_TOKEN">
|
||||
<code class="descname">SAML_HOK_TOKEN</code><em class="property"> = 'com.vmware.vapi.std.security.saml_hok_token'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.SAML_HOK_TOKEN" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SAML_HOK_TOKEN</code><em class="property"> = 'com.vmware.vapi.std.security.saml_hok_token'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.SAML_HOK_TOKEN" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the security context in a request is using a SAML holder-of-key
|
||||
token based authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
@ -433,7 +434,7 @@ the security context that conforms to the above mentioned format.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.SESSION_ID">
|
||||
<code class="descname">SESSION_ID</code><em class="property"> = 'com.vmware.vapi.std.security.session_id'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.SESSION_ID" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SESSION_ID</code><em class="property"> = 'com.vmware.vapi.std.security.session_id'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.SESSION_ID" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the security context in a request is using a session identifier
|
||||
based authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
@ -456,7 +457,7 @@ the above format.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.USER_PASSWORD">
|
||||
<code class="descname">USER_PASSWORD</code><em class="property"> = 'com.vmware.vapi.std.security.user_pass'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.USER_PASSWORD" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">USER_PASSWORD</code><em class="property"> = 'com.vmware.vapi.std.security.user_pass'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.USER_PASSWORD" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Indicates that the security context in a request is using username/password
|
||||
based authentication scheme.</p>
|
||||
<p>In this scheme, the following pieces of information has to be passed in the
|
||||
@ -482,7 +483,7 @@ above format.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std_client.DynamicID">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.std_client.</code><code class="descname">DynamicID</code><span class="sig-paren">(</span><em>type=None</em>, <em>id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.DynamicID" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std_client.</code><code class="sig-name descname">DynamicID</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.DynamicID" 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">DynamicID</span></code> class represents an identifier for a resource of an
|
||||
arbitrary type.</p>
|
||||
@ -515,7 +516,7 @@ attribute <code class="docutils literal notranslate"><span class="pre">type</spa
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std_client.</code><code class="sig-name descname">LocalizableMessage</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">default_message=None</em>, <em class="sig-param">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 localizable string and message
|
||||
template. Classes include one or more localizable message templates in the
|
||||
@ -552,7 +553,7 @@ no arguments.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.vapi.metadata.authentication package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,7 +186,7 @@
|
||||
classes to retrieve authentication information for operation elements.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.metadata.authentication.service_client.Operation">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.authentication.service_client.</code><code class="descname">Operation</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication.service_client.Operation" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata.authentication.service_client.</code><code class="sig-name descname">Operation</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication.service_client.Operation" 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">Operation</span></code> class provides methods to retrieve authentication
|
||||
information of an operation element.</p>
|
||||
@ -199,13 +199,13 @@ authentication schemes are specified in the authentication definition file.</p>
|
||||
</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>
|
||||
<code class="sig-name 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>
|
||||
<dd><p>Resource type for operation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vapi.metadata.authentication.service_client.Operation.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>operation_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication.service_client.Operation.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">service_id</em>, <em class="sig-param">operation_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication.service_client.Operation.get" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
@ -248,7 +248,7 @@ have any authentication information.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vapi.metadata.authentication.service_client.Operation.list">
|
||||
<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.authentication.service_client.Operation.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication.service_client.Operation.list" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
@ -279,7 +279,7 @@ any operation elements that have authentication information.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.metadata.authentication.service_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata.authentication.service_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
|
||||
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.7 documentation</title>
|
||||
<title>com.vmware.vapi.metadata.metamodel package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,7 +186,7 @@
|
||||
classes to retrieve metamodel information for resource types.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.resource_client.Model">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel.resource_client.</code><code class="descname">Model</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.resource_client.Model" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata.metamodel.resource_client.</code><code class="sig-name descname">Model</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.resource_client.Model" 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">Model</span></code> class provides methods to retrieve information about models.</p>
|
||||
<p>A structure is used as a model if it is used for persisting data about an
|
||||
@ -203,7 +203,7 @@ elements that are model structures for a given resource type.</p>
|
||||
</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>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dd><p>Returns the set of identifiers for the structure elements that are
|
||||
models for the resource type corresponding to <code class="docutils literal notranslate"><span class="pre">resource_id</span></code>.</p>
|
||||
<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
|
||||
@ -236,7 +236,7 @@ exist.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.resource_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata.metamodel.resource_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
@ -249,9 +249,12 @@ exist.</p>
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vapi.metadata.metamodel.service_client">
|
||||
<span id="com-vmware-vapi-metadata-metamodel-service-client-module"></span><h2>com.vmware.vapi.metadata.metamodel.service_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata.metamodel.service_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel.service_client</span></code> module provides
|
||||
classes to retrieve metamodel information about the elements contained in a
|
||||
service element.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.service_client.Operation">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel.service_client.</code><code class="descname">Operation</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata.metamodel.service_client.</code><code class="sig-name descname">Operation</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation" 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">Operation</span></code> class provides methods to retrieve metamodel information
|
||||
of an operation element in the interface definition language.</p>
|
||||
@ -262,13 +265,13 @@ of an operation element in the interface definition language.</p>
|
||||
</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>
|
||||
<code class="sig-name 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>
|
||||
<dd><p>Resource type for operation element.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.service_client.Operation.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>operation_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">service_id</em>, <em class="sig-param">operation_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel.service_client.Operation.get" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
@ -307,7 +310,7 @@ exist in the service element.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.service_client.Operation.list">
|
||||
<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>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
@ -337,7 +340,7 @@ exist in any of the package elements.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.metadata.metamodel.service_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata.metamodel.service_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.vapi.metadata.privilege package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,7 +186,7 @@
|
||||
classes to retrieve privilege information for operation elements.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.metadata.privilege.service_client.Operation">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.privilege.service_client.</code><code class="descname">Operation</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege.service_client.Operation" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata.privilege.service_client.</code><code class="sig-name descname">Operation</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege.service_client.Operation" 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">Operation</span></code> class provides methods to retrieve privilege information
|
||||
of an operation element.</p>
|
||||
@ -201,13 +201,13 @@ file.</p>
|
||||
</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>
|
||||
<code class="sig-name 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>
|
||||
<dd><p>Resource type for operation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vapi.metadata.privilege.service_client.Operation.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>operation_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege.service_client.Operation.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">service_id</em>, <em class="sig-param">operation_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege.service_client.Operation.get" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
@ -250,7 +250,7 @@ have any privilege information.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vapi.metadata.privilege.service_client.Operation.list">
|
||||
<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.privilege.service_client.Operation.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege.service_client.Operation.list" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
@ -281,7 +281,7 @@ any operation elements that have privilege information.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.metadata.privilege.service_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata.privilege.service_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vapi.std package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
<title>com.vmware.vapi.std package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -187,7 +187,7 @@ provides some classes intended to be used as payload to provide additional
|
||||
information about those exceptions.</p>
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.AlreadyExists">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">AlreadyExists</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.AlreadyExists" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">AlreadyExists</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.AlreadyExists" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AlreadyExists</span></code> exception indicates that an attempt was made to
|
||||
create an entity but the entity already exists. Typically the entity has a
|
||||
@ -250,7 +250,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.AlreadyInDesiredState">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">AlreadyInDesiredState</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">AlreadyInDesiredState</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AlreadyInDesiredState</span></code> exception indicates that an attempt to change
|
||||
the state of a resource or service had no effect because the resource or
|
||||
@ -305,7 +305,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std.errors_client.ArgumentLocations">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">ArgumentLocations</code><span class="sig-paren">(</span><em>primary=None</em>, <em>secondary=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">ArgumentLocations</code><span class="sig-paren">(</span><em class="sig-param">primary=None</em>, <em class="sig-param">secondary=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" 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">ArgumentLocations</span></code> class describes which part(s) of the input to the
|
||||
method caused the exception.</p>
|
||||
@ -334,7 +334,7 @@ exception.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Canceled">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">Canceled</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Canceled" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">Canceled</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Canceled" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Canceled</span></code> exception indicates that the method canceled itself in
|
||||
response to an explicit request to do so. Methods being “canceled” for
|
||||
@ -406,7 +406,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.ConcurrentChange">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">ConcurrentChange</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ConcurrentChange" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">ConcurrentChange</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ConcurrentChange" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ConcurrentChange</span></code> exception indicates that a data structure, entity,
|
||||
or resource has been modified since some earlier point in time. Typically
|
||||
@ -458,7 +458,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">Error</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">Error</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error" 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.error.VapiError</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Error</span></code> exception describes theattributes common to all standard
|
||||
exceptions.</p>
|
||||
@ -516,7 +516,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type">
|
||||
<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.vapi.std.errors_client.Error.Type" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.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>Enumeration of all standard errors. Used as discriminator in protocols that
|
||||
have no standard means for transporting the error type, e.g. REST. This
|
||||
@ -538,175 +538,175 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.ALREADY_EXISTS">
|
||||
<code class="descname">ALREADY_EXISTS</code><em class="property"> = Type(string='ALREADY_EXISTS')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.ALREADY_EXISTS" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">ALREADY_EXISTS</code><em class="property"> = Type(string='ALREADY_EXISTS')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.ALREADY_EXISTS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#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">AlreadyExists</span></code></a> type. This class attribute was
|
||||
added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.ALREADY_IN_DESIRED_STATE">
|
||||
<code class="descname">ALREADY_IN_DESIRED_STATE</code><em class="property"> = Type(string='ALREADY_IN_DESIRED_STATE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.ALREADY_IN_DESIRED_STATE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">ALREADY_IN_DESIRED_STATE</code><em class="property"> = Type(string='ALREADY_IN_DESIRED_STATE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.ALREADY_IN_DESIRED_STATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">AlreadyInDesiredState</span></code></a> type. This class
|
||||
attribute was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.CANCELED">
|
||||
<code class="descname">CANCELED</code><em class="property"> = Type(string='CANCELED')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.CANCELED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">CANCELED</code><em class="property"> = Type(string='CANCELED')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.CANCELED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.Canceled" title="com.vmware.vapi.std.errors_client.Canceled"><code class="xref py py-class docutils literal notranslate"><span class="pre">Canceled</span></code></a> type. This class attribute was
|
||||
added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.CONCURRENT_CHANGE">
|
||||
<code class="descname">CONCURRENT_CHANGE</code><em class="property"> = Type(string='CONCURRENT_CHANGE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.CONCURRENT_CHANGE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">CONCURRENT_CHANGE</code><em class="property"> = Type(string='CONCURRENT_CHANGE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.CONCURRENT_CHANGE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.ConcurrentChange" title="com.vmware.vapi.std.errors_client.ConcurrentChange"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConcurrentChange</span></code></a> type. This class attribute
|
||||
was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.ERROR">
|
||||
<code class="descname">ERROR</code><em class="property"> = Type(string='ERROR')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">ERROR</code><em class="property"> = Type(string='ERROR')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#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">Error</span></code></a> type. This class attribute was added
|
||||
in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.FEATURE_IN_USE">
|
||||
<code class="descname">FEATURE_IN_USE</code><em class="property"> = Type(string='FEATURE_IN_USE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.FEATURE_IN_USE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FEATURE_IN_USE</code><em class="property"> = Type(string='FEATURE_IN_USE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.FEATURE_IN_USE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FeatureInUse" title="com.vmware.vapi.std.errors_client.FeatureInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">FeatureInUse</span></code></a> type. This class attribute was
|
||||
added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.INTERNAL_SERVER_ERROR">
|
||||
<code class="descname">INTERNAL_SERVER_ERROR</code><em class="property"> = Type(string='INTERNAL_SERVER_ERROR')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INTERNAL_SERVER_ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">INTERNAL_SERVER_ERROR</code><em class="property"> = Type(string='INTERNAL_SERVER_ERROR')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INTERNAL_SERVER_ERROR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.InternalServerError" title="com.vmware.vapi.std.errors_client.InternalServerError"><code class="xref py py-class docutils literal notranslate"><span class="pre">InternalServerError</span></code></a> type. This class
|
||||
attribute was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.INVALID_ARGUMENT">
|
||||
<code class="descname">INVALID_ARGUMENT</code><em class="property"> = Type(string='INVALID_ARGUMENT')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INVALID_ARGUMENT" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">INVALID_ARGUMENT</code><em class="property"> = Type(string='INVALID_ARGUMENT')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INVALID_ARGUMENT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#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">InvalidArgument</span></code></a> type. This class attribute
|
||||
was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.INVALID_ELEMENT_CONFIGURATION">
|
||||
<code class="descname">INVALID_ELEMENT_CONFIGURATION</code><em class="property"> = Type(string='INVALID_ELEMENT_CONFIGURATION')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INVALID_ELEMENT_CONFIGURATION" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">INVALID_ELEMENT_CONFIGURATION</code><em class="property"> = Type(string='INVALID_ELEMENT_CONFIGURATION')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INVALID_ELEMENT_CONFIGURATION" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.InvalidElementConfiguration" title="com.vmware.vapi.std.errors_client.InvalidElementConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidElementConfiguration</span></code></a> type. This class
|
||||
attribute was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.INVALID_ELEMENT_TYPE">
|
||||
<code class="descname">INVALID_ELEMENT_TYPE</code><em class="property"> = Type(string='INVALID_ELEMENT_TYPE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INVALID_ELEMENT_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">INVALID_ELEMENT_TYPE</code><em class="property"> = Type(string='INVALID_ELEMENT_TYPE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INVALID_ELEMENT_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidElementType</span></code></a> type. This class
|
||||
attribute was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.INVALID_REQUEST">
|
||||
<code class="descname">INVALID_REQUEST</code><em class="property"> = Type(string='INVALID_REQUEST')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INVALID_REQUEST" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">INVALID_REQUEST</code><em class="property"> = Type(string='INVALID_REQUEST')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INVALID_REQUEST" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.InvalidRequest" title="com.vmware.vapi.std.errors_client.InvalidRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidRequest</span></code></a> type. This class attribute
|
||||
was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.NOT_ALLOWED_IN_CURRENT_STATE">
|
||||
<code class="descname">NOT_ALLOWED_IN_CURRENT_STATE</code><em class="property"> = Type(string='NOT_ALLOWED_IN_CURRENT_STATE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.NOT_ALLOWED_IN_CURRENT_STATE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NOT_ALLOWED_IN_CURRENT_STATE</code><em class="property"> = Type(string='NOT_ALLOWED_IN_CURRENT_STATE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.NOT_ALLOWED_IN_CURRENT_STATE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#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">NotAllowedInCurrentState</span></code></a> type. This class
|
||||
attribute was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.NOT_FOUND">
|
||||
<code class="descname">NOT_FOUND</code><em class="property"> = Type(string='NOT_FOUND')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.NOT_FOUND" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NOT_FOUND</code><em class="property"> = Type(string='NOT_FOUND')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.NOT_FOUND" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#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">NotFound</span></code></a> type. This class attribute was
|
||||
added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.OPERATION_NOT_FOUND">
|
||||
<code class="descname">OPERATION_NOT_FOUND</code><em class="property"> = Type(string='OPERATION_NOT_FOUND')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.OPERATION_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">OPERATION_NOT_FOUND</code><em class="property"> = Type(string='OPERATION_NOT_FOUND')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.OPERATION_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.OperationNotFound" title="com.vmware.vapi.std.errors_client.OperationNotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationNotFound</span></code></a> type. This class attribute
|
||||
was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_BUSY">
|
||||
<code class="descname">RESOURCE_BUSY</code><em class="property"> = Type(string='RESOURCE_BUSY')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_BUSY" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RESOURCE_BUSY</code><em class="property"> = Type(string='RESOURCE_BUSY')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_BUSY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#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">ResourceBusy</span></code></a> type. This class attribute was
|
||||
added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_INACCESSIBLE">
|
||||
<code class="descname">RESOURCE_INACCESSIBLE</code><em class="property"> = Type(string='RESOURCE_INACCESSIBLE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_INACCESSIBLE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RESOURCE_INACCESSIBLE</code><em class="property"> = Type(string='RESOURCE_INACCESSIBLE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_INACCESSIBLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceInaccessible</span></code></a> type. This class
|
||||
attribute was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_IN_USE">
|
||||
<code class="descname">RESOURCE_IN_USE</code><em class="property"> = Type(string='RESOURCE_IN_USE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_IN_USE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RESOURCE_IN_USE</code><em class="property"> = Type(string='RESOURCE_IN_USE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_IN_USE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceInUse</span></code></a> type. This class attribute was
|
||||
added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.SERVICE_UNAVAILABLE">
|
||||
<code class="descname">SERVICE_UNAVAILABLE</code><em class="property"> = Type(string='SERVICE_UNAVAILABLE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.SERVICE_UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SERVICE_UNAVAILABLE</code><em class="property"> = Type(string='SERVICE_UNAVAILABLE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.SERVICE_UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#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">ServiceUnavailable</span></code></a> type. This class
|
||||
attribute was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.TIMED_OUT">
|
||||
<code class="descname">TIMED_OUT</code><em class="property"> = Type(string='TIMED_OUT')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.TIMED_OUT" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">TIMED_OUT</code><em class="property"> = Type(string='TIMED_OUT')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.TIMED_OUT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimedOut</span></code></a> type. This class attribute was
|
||||
added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.UNABLE_TO_ALLOCATE_RESOURCE">
|
||||
<code class="descname">UNABLE_TO_ALLOCATE_RESOURCE</code><em class="property"> = Type(string='UNABLE_TO_ALLOCATE_RESOURCE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNABLE_TO_ALLOCATE_RESOURCE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">UNABLE_TO_ALLOCATE_RESOURCE</code><em class="property"> = Type(string='UNABLE_TO_ALLOCATE_RESOURCE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNABLE_TO_ALLOCATE_RESOURCE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#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">UnableToAllocateResource</span></code></a> type. This class
|
||||
attribute was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.UNAUTHENTICATED">
|
||||
<code class="descname">UNAUTHENTICATED</code><em class="property"> = Type(string='UNAUTHENTICATED')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNAUTHENTICATED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">UNAUTHENTICATED</code><em class="property"> = Type(string='UNAUTHENTICATED')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNAUTHENTICATED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#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">Unauthenticated</span></code></a> type. This class attribute
|
||||
was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.UNAUTHORIZED">
|
||||
<code class="descname">UNAUTHORIZED</code><em class="property"> = Type(string='UNAUTHORIZED')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNAUTHORIZED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">UNAUTHORIZED</code><em class="property"> = Type(string='UNAUTHORIZED')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNAUTHORIZED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#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">Unauthorized</span></code></a> type. This class attribute was
|
||||
added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.UNEXPECTED_INPUT">
|
||||
<code class="descname">UNEXPECTED_INPUT</code><em class="property"> = Type(string='UNEXPECTED_INPUT')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNEXPECTED_INPUT" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">UNEXPECTED_INPUT</code><em class="property"> = Type(string='UNEXPECTED_INPUT')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNEXPECTED_INPUT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.UnexpectedInput" title="com.vmware.vapi.std.errors_client.UnexpectedInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnexpectedInput</span></code></a> type. This class attribute
|
||||
was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.UNSUPPORTED">
|
||||
<code class="descname">UNSUPPORTED</code><em class="property"> = Type(string='UNSUPPORTED')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNSUPPORTED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">UNSUPPORTED</code><em class="property"> = Type(string='UNSUPPORTED')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNSUPPORTED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#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">Unsupported</span></code></a> type. This class attribute was
|
||||
added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Error.Type.UNVERIFIED_PEER">
|
||||
<code class="descname">UNVERIFIED_PEER</code><em class="property"> = Type(string='UNVERIFIED_PEER')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNVERIFIED_PEER" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">UNVERIFIED_PEER</code><em class="property"> = Type(string='UNVERIFIED_PEER')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNVERIFIED_PEER" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="com.vmware.vapi.std.errors_client.UnverifiedPeer"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnverifiedPeer</span></code></a> type. This class attribute
|
||||
was added in vSphere API 6.7.2.</p>
|
||||
</dd></dl>
|
||||
@ -717,7 +717,7 @@ was added in vSphere API 6.7.2.</p>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.FeatureInUse">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">FeatureInUse</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.FeatureInUse" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">FeatureInUse</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.FeatureInUse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">FeatureInUse</span></code> exception indicates that an action cannot be completed
|
||||
because a feature is in use.</p>
|
||||
@ -772,7 +772,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std.errors_client.FileLocations">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">FileLocations</code><span class="sig-paren">(</span><em>primary=None</em>, <em>secondary=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.FileLocations" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">FileLocations</code><span class="sig-paren">(</span><em class="sig-param">primary=None</em>, <em class="sig-param">secondary=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.FileLocations" 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">FileLocations</span></code> class identifies the file(s) that caused the method
|
||||
to report the exception.</p>
|
||||
@ -798,7 +798,7 @@ that caused the primary file to trigger the exception.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.InternalServerError">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">InternalServerError</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InternalServerError" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">InternalServerError</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InternalServerError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">InternalServerError</span></code> exception indicates that the server encounters
|
||||
an unexpected condition that prevented it from fulfilling the request.</p>
|
||||
@ -857,7 +857,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.InvalidArgument">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">InvalidArgument</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InvalidArgument" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">InvalidArgument</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InvalidArgument" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidArgument</span></code> exception indicates that the values received for
|
||||
one or more parameters are not acceptable.</p>
|
||||
@ -937,7 +937,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.InvalidElementConfiguration">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">InvalidElementConfiguration</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InvalidElementConfiguration" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">InvalidElementConfiguration</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InvalidElementConfiguration" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidElementConfiguration</span></code> exception indicates that an attempt to
|
||||
modify the configuration of an element or a group containing the element
|
||||
@ -998,7 +998,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.InvalidElementType">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">InvalidElementType</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InvalidElementType" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">InvalidElementType</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InvalidElementType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidElementType</span></code> exception indicates that the server was unable
|
||||
to fulfil the request because an element of a specific type cannot be a
|
||||
@ -1064,7 +1064,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.InvalidRequest">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">InvalidRequest</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InvalidRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">InvalidRequest</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InvalidRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidRequest</span></code> exception indicates that the request is malformed in
|
||||
such a way that the server is unable to process it.</p>
|
||||
@ -1139,7 +1139,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">NotAllowedInCurrentState</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">NotAllowedInCurrentState</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">NotAllowedInCurrentState</span></code> exception indicates that the requested
|
||||
method is not allowed with a resource or service in its current state. This
|
||||
@ -1208,7 +1208,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.NotFound">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">NotFound</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.NotFound" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">NotFound</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.NotFound" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">NotFound</span></code> exception indicates that a specified element could not be
|
||||
found.</p>
|
||||
@ -1268,7 +1268,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.OperationNotFound">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">OperationNotFound</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.OperationNotFound" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">OperationNotFound</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.OperationNotFound" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">OperationNotFound</span></code> exception indicates that the method specified in
|
||||
the request could not be found.</p>
|
||||
@ -1339,7 +1339,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.ResourceBusy">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">ResourceBusy</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ResourceBusy" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">ResourceBusy</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ResourceBusy" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ResourceBusy</span></code> exception indicates that the method could not be
|
||||
completed because a resource it needs is busy.</p>
|
||||
@ -1402,7 +1402,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.ResourceInUse">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">ResourceInUse</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ResourceInUse" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">ResourceInUse</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ResourceInUse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ResourceInUse</span></code> exception indicates that the method could not be
|
||||
completed because a resource is in use.</p>
|
||||
@ -1466,7 +1466,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.ResourceInaccessible">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">ResourceInaccessible</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">ResourceInaccessible</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ResourceInaccessible</span></code> exception indicates that the method could not
|
||||
be completed because an entity is not accessible.</p>
|
||||
@ -1533,7 +1533,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.ServiceUnavailable">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">ServiceUnavailable</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">ServiceUnavailable</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ServiceUnavailable</span></code> exception indicates that the class is
|
||||
unavailable.</p>
|
||||
@ -1600,7 +1600,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std.errors_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.std.errors_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.errors_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_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">
|
||||
@ -1612,7 +1612,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.TimedOut">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">TimedOut</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.TimedOut" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">TimedOut</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.TimedOut" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">TimedOut</span></code> exception indicates that the method did not complete
|
||||
within the allowed amount of time. The allowed amount of time might be:</p>
|
||||
@ -1685,7 +1685,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std.errors_client.TransientIndication">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">TransientIndication</code><span class="sig-paren">(</span><em>is_transient=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">TransientIndication</code><span class="sig-paren">(</span><em class="sig-param">is_transient=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.TransientIndication" 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">TransientIndication</span></code> class indicates whether or not the exception is
|
||||
transient.</p>
|
||||
@ -1708,7 +1708,7 @@ transient.</p>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.UnableToAllocateResource">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">UnableToAllocateResource</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">UnableToAllocateResource</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">UnableToAllocateResource</span></code> exception indicates that the method failed
|
||||
because it was unable to allocate or acquire a required resource.</p>
|
||||
@ -1782,7 +1782,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Unauthenticated">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">Unauthenticated</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Unauthenticated" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">Unauthenticated</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Unauthenticated" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Unauthenticated</span></code> exception indicates that the method requires
|
||||
authentication and the user is not authenticated.</p>
|
||||
@ -1855,7 +1855,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Unauthorized">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">Unauthorized</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Unauthorized" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">Unauthorized</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Unauthorized" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Unauthorized</span></code> exception indicates that the user is not authorized to
|
||||
perform the method.</p>
|
||||
@ -1938,7 +1938,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.UnexpectedInput">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">UnexpectedInput</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.UnexpectedInput" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">UnexpectedInput</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.UnexpectedInput" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">UnexpectedInput</span></code> exception indicates that the request contained a
|
||||
parameter or attribute whose name is not known by the server.</p>
|
||||
@ -2005,7 +2005,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.Unsupported">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">Unsupported</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Unsupported" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">Unsupported</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Unsupported" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Unsupported</span></code> exception indicates that the method is not supported by
|
||||
the class.</p>
|
||||
@ -2062,7 +2062,7 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
|
||||
<dl class="exception">
|
||||
<dt id="com.vmware.vapi.std.errors_client.UnverifiedPeer">
|
||||
<em class="property">exception </em><code class="descclassname">com.vmware.vapi.std.errors_client.</code><code class="descname">UnverifiedPeer</code><span class="sig-paren">(</span><em>messages=None</em>, <em>data=None</em>, <em>error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">UnverifiedPeer</code><span class="sig-paren">(</span><em class="sig-param">messages=None</em>, <em class="sig-param">data=None</em>, <em class="sig-param">error_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">UnverifiedPeer</span></code> exception indicates that an attempt to connect to an
|
||||
unknown or not-yet-trusted endpoint failed because the system was unable to
|
||||
@ -2125,6 +2125,136 @@ Can be None for compatibility with preceding implementations.</p></li>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vapi.std.interposition_client">
|
||||
<span id="com-vmware-vapi-std-interposition-client-module"></span><h2>com.vmware.vapi.std.interposition_client module<a class="headerlink" href="#module-com.vmware.vapi.std.interposition_client" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.interposition_client</span></code> module provides classes that
|
||||
TODO.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std.interposition_client.InvocationRequest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.interposition_client.</code><code class="sig-name descname">InvocationRequest</code><span class="sig-paren">(</span><em class="sig-param">service_id=None</em>, <em class="sig-param">operation_id=None</em>, <em class="sig-param">operation_input=None</em>, <em class="sig-param">user=None</em>, <em class="sig-param">groups=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.interposition_client.InvocationRequest" 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>Information about an interposed request for operation invocation. All
|
||||
interposers would receive an instance of this structure as an input
|
||||
parameter.</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>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Fully qualified name of the service which contains the interposed
|
||||
operation. In canonical format. For example org.example.hello.</p></li>
|
||||
<li><p><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the interposed operation. In canonical format. For example
|
||||
say_hello.</p></li>
|
||||
<li><p><strong>operation_input</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">DataValue</span></code>) – Input of the interposed operation.</p></li>
|
||||
<li><p><strong>user</strong> (<a class="reference internal" href="#com.vmware.vapi.std.interposition_client.SecurityPrincipal" title="com.vmware.vapi.std.interposition_client.SecurityPrincipal"><code class="xref py py-class docutils literal notranslate"><span class="pre">SecurityPrincipal</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – User which started the interposed operation.
|
||||
There could be no authentication information. For example when
|
||||
methods are invoked anonymously.</p></li>
|
||||
<li><p><strong>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.vapi.std.interposition_client.SecurityPrincipal" title="com.vmware.vapi.std.interposition_client.SecurityPrincipal"><code class="xref py py-class docutils literal notranslate"><span class="pre">SecurityPrincipal</span></code></a>) – Groups of the user who started the interposed operation. Would be
|
||||
empty if there is no authentication information.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std.interposition_client.InvocationResult">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.interposition_client.</code><code class="sig-name descname">InvocationResult</code><span class="sig-paren">(</span><em class="sig-param">result_type=None</em>, <em class="sig-param">output=None</em>, <em class="sig-param">error=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.interposition_client.InvocationResult" 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>Information about the result from an interposed operation invocation. All
|
||||
POST interposers will receive an instance of this structure.</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>result_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.interposition_client.InvocationResult.ResultType" title="com.vmware.vapi.std.interposition_client.InvocationResult.ResultType"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvocationResult.ResultType</span></code></a>) – Type of the invocation result.</p></li>
|
||||
<li><p><strong>output</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">DataValue</span></code>) – Normal result value.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">resultType</span></code> is
|
||||
<a class="reference internal" href="#com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.NORMAL_RESULT" title="com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.NORMAL_RESULT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">InvocationResult.ResultType.NORMAL_RESULT</span></code></a>.</p></li>
|
||||
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) – Error result value.
|
||||
This attribute is optional and it is only relevant when the value
|
||||
of <code class="docutils literal notranslate"><span class="pre">resultType</span></code> is
|
||||
<a class="reference internal" href="#com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.ERROR_RESULT" title="com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.ERROR_RESULT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">InvocationResult.ResultType.ERROR_RESULT</span></code></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std.interposition_client.InvocationResult.ResultType">
|
||||
<em class="property">class </em><code class="sig-name descname">ResultType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.interposition_client.InvocationResult.ResultType" 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>Type of the invocation result.</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 <code class="xref py py-class docutils literal notranslate"><span class="pre">ResultType</span></code> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.ERROR_RESULT">
|
||||
<code class="sig-name descname">ERROR_RESULT</code><em class="property"> = ResultType(string='ERROR_RESULT')</em><a class="headerlink" href="#com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.ERROR_RESULT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Error invocation result.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.NORMAL_RESULT">
|
||||
<code class="sig-name descname">NORMAL_RESULT</code><em class="property"> = ResultType(string='NORMAL_RESULT')</em><a class="headerlink" href="#com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.NORMAL_RESULT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Normal invocation result.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std.interposition_client.SecurityPrincipal">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.interposition_client.</code><code class="sig-name descname">SecurityPrincipal</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">domain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.interposition_client.SecurityPrincipal" 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>VMODL equivalent of com.vmware.vapi.security.PrincipalId.</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>) – Principal name.</p></li>
|
||||
<li><p><strong>domain</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>) – Principal domain.
|
||||
Domain is optional in <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.security.PrincipalId</span></code></p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vapi.std.interposition_client.StubFactory">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.interposition_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.interposition_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>
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<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>
|
||||
<title>com.vmware.vcenter.certificate_management package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -184,7 +184,7 @@
|
||||
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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">
|
||||
@ -196,7 +196,7 @@ provides classes to manage certificates.</p>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="sig-name descname">Tls</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -207,7 +207,7 @@ class was added in vSphere API 6.7.2.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">version=None</em>, <em class="sig-param">serial_number=None</em>, <em class="sig-param">signature_algorithm=None</em>, <em class="sig-param">issuer_dn=None</em>, <em class="sig-param">valid_from=None</em>, <em class="sig-param">valid_to=None</em>, <em class="sig-param">subject_dn=None</em>, <em class="sig-param">thumbprint=None</em>, <em class="sig-param">is_ca=None</em>, <em class="sig-param">path_length_constraint=None</em>, <em class="sig-param">key_usage=None</em>, <em class="sig-param">extended_key_usage=None</em>, <em class="sig-param">subject_alternative_name=None</em>, <em class="sig-param">authority_information_access_uri=None</em>, <em class="sig-param">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>
|
||||
@ -259,7 +259,7 @@ API 6.7.2.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-name descname">ReplaceSpec</code><span class="sig-paren">(</span><em class="sig-param">key_size=None</em>, <em class="sig-param">common_name=None</em>, <em class="sig-param">organization=None</em>, <em class="sig-param">organization_unit=None</em>, <em class="sig-param">locality=None</em>, <em class="sig-param">state_or_province=None</em>, <em class="sig-param">country=None</em>, <em class="sig-param">email_address=None</em>, <em class="sig-param">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
|
||||
@ -301,7 +301,7 @@ certificate generation .</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-name descname">Spec</code><span class="sig-paren">(</span><em class="sig-param">cert=None</em>, <em class="sig-param">key=None</em>, <em class="sig-param">root_cert=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>
|
||||
@ -320,6 +320,12 @@ 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>
|
||||
<li><p><strong>root_cert</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>) – Third party Root CA certificate in PEM format. This attribute was
|
||||
added in vSphere API 6.9.1.
|
||||
If None the new third party root CA certificate will not be added
|
||||
to the trust store. It is required when replacing the certificate
|
||||
with a third party signed certificate if the root certificate of
|
||||
the third party is not already a trusted root.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@ -327,7 +333,7 @@ signed certificate.</p></li>
|
||||
|
||||
<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>
|
||||
<code class="sig-name 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">
|
||||
@ -345,16 +351,23 @@ if the rhttpproxy certificate is not present in VECS store.</p>
|
||||
<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>
|
||||
<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="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</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>
|
||||
<code class="sig-name descname">renew</code><span class="sig-paren">(</span><em class="sig-param">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.</p>
|
||||
<p>After this method completes, the services using the certificate will 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
|
||||
@ -373,12 +386,49 @@ If the duration period specified is invalid.</p>
|
||||
<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>
|
||||
<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="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.replace_vmca_signed">
|
||||
<code class="sig-name descname">replace_vmca_signed</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.replace_vmca_signed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Replace MACHINE SSL with VMCA signed one with the given Spec.The system
|
||||
will go for restart.</p>
|
||||
<p>After this method completes, the services using the certificate will be
|
||||
restarted for the new certificate to take effect.. This method was
|
||||
added in vSphere API 6.9.1.</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.ReplaceSpec" title="com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tls.ReplaceSpec</span></code></a>) – The information needed to generate VMCA signed Machine SSL</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 the Spec given is not complete or 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 the system failed to replace the machine ssl 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.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="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</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>
|
||||
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">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">
|
||||
@ -398,10 +448,10 @@ 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>
|
||||
<p>After this method completes, the services using the certificate will be
|
||||
restarted for the new certificate to take effect.</p>
|
||||
<p>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>
|
||||
@ -419,6 +469,13 @@ TLS certificate thumbprint.</p>
|
||||
<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>
|
||||
<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="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
@ -426,7 +483,7 @@ If the system failed to replace the TLS certificate.</p>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="sig-name descname">TlsCsr</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -437,7 +494,7 @@ request. This class was added in vSphere API 6.7.2.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -456,7 +513,7 @@ in vSphere API 6.7.2.</p>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-name descname">Spec</code><span class="sig-paren">(</span><em class="sig-param">key_size=None</em>, <em class="sig-param">common_name=None</em>, <em class="sig-param">organization=None</em>, <em class="sig-param">organization_unit=None</em>, <em class="sig-param">locality=None</em>, <em class="sig-param">state_or_province=None</em>, <em class="sig-param">country=None</em>, <em class="sig-param">email_address=None</em>, <em class="sig-param">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>
|
||||
@ -493,7 +550,7 @@ subjectAltName is list of Dns Names and Ip addresses</p></li>
|
||||
|
||||
<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>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">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">
|
||||
@ -510,6 +567,14 @@ API 6.7.2.</p>
|
||||
<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>
|
||||
<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="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Manage</span></code> and
|
||||
<code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
@ -517,7 +582,7 @@ If CSR could not be created for given spec for a generic error.</p>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="sig-name descname">TrustedRootChains</code><span class="sig-paren">(</span><em class="sig-param">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
|
||||
@ -529,7 +594,7 @@ vSphere API 6.7.2.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">cert_chain=None</em>, <em class="sig-param">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>
|
||||
@ -557,7 +622,7 @@ A unique id will be generated if not given.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -576,7 +641,7 @@ vSphere API 6.7.2.</p>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">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
|
||||
@ -596,7 +661,7 @@ API 6.7.2.</p>
|
||||
|
||||
<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>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">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">
|
||||
@ -617,12 +682,20 @@ if authorization is not given to caller.</p>
|
||||
<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>
|
||||
<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="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Manage</span></code> and
|
||||
<code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</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>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">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">
|
||||
@ -637,12 +710,20 @@ if authorization is not given to caller.</p>
|
||||
<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>
|
||||
<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="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Manage</span></code> and
|
||||
<code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</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>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">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">
|
||||
@ -663,12 +744,19 @@ if authorization is not given to caller.</p>
|
||||
<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>
|
||||
<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="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</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>
|
||||
<code class="sig-name 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">
|
||||
@ -682,6 +770,101 @@ This method was added in vSphere API 6.7.2.</p>
|
||||
<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>
|
||||
<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="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="sig-name descname">VmcaRoot</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot" 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">VmcaRoot</span></code> interface provides methods to replace VMware Certificate
|
||||
Authority (VMCA) root certificate. This class was added in vSphere API
|
||||
6.9.1.</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.VmcaRoot.CreateSpec">
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">key_size=None</em>, <em class="sig-param">common_name=None</em>, <em class="sig-param">organization=None</em>, <em class="sig-param">organization_unit=None</em>, <em class="sig-param">locality=None</em>, <em class="sig-param">state_or_province=None</em>, <em class="sig-param">country=None</em>, <em class="sig-param">email_address=None</em>, <em class="sig-param">subject_alt_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.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">VmcaRoot.CreateSpec</span></code> contains information. to generate a Private Key
|
||||
and CSR. This class was added in vSphere API 6.9.1.</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.9.1.
|
||||
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.9.1.
|
||||
If None the common name will be the primary network identifier
|
||||
(PNID) of the vCenter Virtual Server Appliance (VCSA).</p></li>
|
||||
<li><p><strong>organization</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>) – Organization field in certificate subject. This attribute was added
|
||||
in vSphere API 6.9.1.
|
||||
If None the organization will be ‘VMware’.</p></li>
|
||||
<li><p><strong>organization_unit</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>) – Organization unit field in certificate subject. This attribute was
|
||||
added in vSphere API 6.9.1.
|
||||
If None the organization unit will be ‘VMware Engineering’.</p></li>
|
||||
<li><p><strong>locality</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>) – Locality field in certificate subject. This attribute was added in
|
||||
vSphere API 6.9.1.
|
||||
If None the locality will be ‘Palo Alto’.</p></li>
|
||||
<li><p><strong>state_or_province</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>) – State field in certificate subject. This attribute was added in
|
||||
vSphere API 6.9.1.
|
||||
If None the state will be ‘California’.</p></li>
|
||||
<li><p><strong>country</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>) – Country field in certificate subject. This attribute was added in
|
||||
vSphere API 6.9.1.
|
||||
If None the country will be ‘US’.</p></li>
|
||||
<li><p><strong>email_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>) – Email field in Certificate extensions. This attribute was added in
|
||||
vSphere API 6.9.1.
|
||||
If None the emailAddress will be ‘email\@acme.com’.</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.9.1.
|
||||
If None PNID of host will be used as IPAddress or Hostname for
|
||||
certificate generation.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.create">
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Replace Root Certificate with VMCA signed one using the given Spec.</p>
|
||||
<p>After this method completes, the services using the certificate will be
|
||||
restarted for the new certificate to take effect.. This method was
|
||||
added in vSphere API 6.9.1.</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.VmcaRoot.CreateSpec" title="com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmcaRoot.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The information needed to generate VMCA signed Root Certificate.
|
||||
Default values will be set for all null parameters.</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>
|
||||
<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="simple">
|
||||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.vcenter.compute package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -208,7 +208,7 @@
|
||||
managing compute policies.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies_client.</code><code class="descname">Capabilities</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><code class="sig-name descname">Capabilities</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities" 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">Capabilities</span></code> class provides methods to manage compute policy
|
||||
capabilities. The description of the capability provides information about
|
||||
@ -227,7 +227,7 @@ release.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">create_spec_type=None</em>, <em class="sig-param">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>
|
||||
<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">Capabilities.Info</span></code> class contains information about a compute policy
|
||||
capability. <strong>Warning:</strong> This class is available as technical preview. It
|
||||
@ -272,7 +272,7 @@ the resource type: <code class="docutils literal notranslate"><span class="pre">
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.RESOURCE_TYPE">
|
||||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vcenter.compute.policies.Capability'</em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vcenter.compute.policies.Capability'</em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The resource type for the compute policy capability. <strong>Warning:</strong> This class
|
||||
attribute is available as technical preview. It may be changed in a future
|
||||
release.</p>
|
||||
@ -280,7 +280,7 @@ release.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.Summary">
|
||||
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>capability=None</em>, <em>name=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">capability=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.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">Capabilities.Summary</span></code> class contains commonly used information about
|
||||
a compute policy capability. <strong>Warning:</strong> This class is available as
|
||||
@ -314,7 +314,7 @@ release.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>capability</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">capability</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.get" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
@ -351,7 +351,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.list" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
@ -381,7 +381,7 @@ if you do not have all of the privileges described as follows:</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.CreateSpec">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies_client.</code><code class="descname">CreateSpec</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.vcenter.compute.policies_client.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_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 common information used to create a new
|
||||
policy. <strong>Warning:</strong> This class is available as technical preview. It may
|
||||
@ -406,7 +406,7 @@ as technical preview. It may be changed in a future release.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Info">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies_client.</code><code class="descname">Info</code><span class="sig-paren">(</span><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_client.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">capability=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_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 common information about a compute policy.
|
||||
<strong>Warning:</strong> This class is available as technical preview. It may be
|
||||
@ -438,29 +438,10 @@ be an identifier for the resource type:
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Status">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>status=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Status</span></code> class describes the current status of a compute 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="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>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.</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>
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><code class="sig-name descname">ObjectCompliance</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance" 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">Status.Compliance</span></code> class defines the compliance states a policy can
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">ObjectCompliance</span></code> class defines the compliance states a policy can
|
||||
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">
|
||||
@ -475,28 +456,28 @@ 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 <code class="xref py py-class docutils literal notranslate"><span class="pre">Compliance</span></code> instance.</p>
|
||||
<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.vcenter.compute.policies_client.ObjectCompliance" title="com.vmware.vcenter.compute.policies_client.ObjectCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectCompliance</span></code></a> 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>
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance.COMPLIANT">
|
||||
<code class="sig-name descname">COMPLIANT</code><em class="property"> = ObjectCompliance(string='COMPLIANT')</em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The policy is in compliance on the object. <strong>Warning:</strong> This class
|
||||
attribute is available as technical preview. It may be changed in a future
|
||||
release.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Status.Compliance.NOT_APPLICABLE">
|
||||
<code class="descname">NOT_APPLICABLE</code><em class="property"> = Compliance(string='NOT_APPLICABLE')</em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Status.Compliance.NOT_APPLICABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_APPLICABLE">
|
||||
<code class="sig-name descname">NOT_APPLICABLE</code><em class="property"> = ObjectCompliance(string='NOT_APPLICABLE')</em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_APPLICABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The object is in a state for which the policy does not apply. <strong>Warning:</strong>
|
||||
This class attribute is available as technical preview. It may be changed
|
||||
in a future release.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Status.Compliance.NOT_COMPLIANT">
|
||||
<code class="descname">NOT_COMPLIANT</code><em class="property"> = Compliance(string='NOT_COMPLIANT')</em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Status.Compliance.NOT_COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_COMPLIANT">
|
||||
<code class="sig-name descname">NOT_COMPLIANT</code><em class="property"> = ObjectCompliance(string='NOT_COMPLIANT')</em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The policy is not in compliance on the object. <strong>Warning:</strong> This class
|
||||
attribute is available as technical preview. It may be changed in a future
|
||||
release.</p>
|
||||
@ -504,11 +485,30 @@ release.</p>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.Status">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">status=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">Status</span></code> class describes the current status of a compute 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="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>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance" title="com.vmware.vcenter.compute.policies_client.ObjectCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectCompliance</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.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
@ -520,7 +520,7 @@ release.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.TagUsage">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies_client.</code><code class="descname">TagUsage</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies_client.</code><code class="sig-name descname">TagUsage</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage" 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">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
|
||||
@ -532,7 +532,7 @@ be changed in a future release.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">policies=None</em>, <em class="sig-param">tags=None</em>, <em class="sig-param">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>
|
||||
<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">TagUsage.FilterSpec</span></code> class contains attributes used to filter the
|
||||
results when listing the tags used by policies as available in this vCenter
|
||||
@ -584,7 +584,7 @@ If None or empty, then tags of any type match this filter.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.TagUsage.Summary">
|
||||
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>policy=None</em>, <em>tag_type=None</em>, <em>tag=None</em>, <em>tag_name=None</em>, <em>category_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">policy=None</em>, <em class="sig-param">tag_type=None</em>, <em class="sig-param">tag=None</em>, <em class="sig-param">tag_name=None</em>, <em class="sig-param">category_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage.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">TagUsage.Summary</span></code> class contains common information about a tag used
|
||||
by a policy. <strong>Warning:</strong> This class is available as technical preview. It
|
||||
@ -638,7 +638,7 @@ may be changed in a future release.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.compute.policies_client.TagUsage.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.vcenter.compute.policies_client.TagUsage.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about the tags used by policies available in 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>. <strong>Warning:</strong>
|
||||
This method is available as technical preview. It may be changed in a
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.vcenter.compute.policies.capabilities package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -190,7 +190,7 @@ 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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.</code><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">vm_tag=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">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
|
||||
@ -229,7 +229,7 @@ as technical preview. It may be changed in a future release.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.</code><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">vm_tag=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">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>
|
||||
@ -275,7 +275,7 @@ be an identifier for the resource type:
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">
|
||||
@ -293,7 +293,7 @@ be an identifier for the resource type:
|
||||
module provides classes for the VM Host affinity capability offered by vCenter.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.CreateSpec">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_host_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_affinity_client.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.</code><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">vm_tag=None</em>, <em class="sig-param">host_tag=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_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 affinity policy, see
|
||||
@ -343,7 +343,7 @@ as technical preview. It may be changed in a future release.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.Info">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_host_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_affinity_client.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.</code><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">vm_tag=None</em>, <em class="sig-param">host_tag=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">capability=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies.capabilities.vm_host_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
|
||||
affinity policy, see
|
||||
@ -401,7 +401,7 @@ be an identifier for the resource type:
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
@ -420,7 +420,7 @@ 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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.</code><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">vm_tag=None</em>, <em class="sig-param">host_tag=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">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
|
||||
@ -470,7 +470,7 @@ as technical preview. It may be changed in a future release.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.</code><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">vm_tag=None</em>, <em class="sig-param">host_tag=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">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
|
||||
@ -528,7 +528,7 @@ be an identifier for the resource type:
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">
|
||||
@ -545,7 +545,7 @@ be an identifier for the resource type:
|
||||
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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.</code><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">vm_tag=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">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
|
||||
@ -583,7 +583,7 @@ as technical preview. It may be changed in a future release.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.</code><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">vm_tag=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">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
|
||||
@ -628,7 +628,7 @@ be an identifier for the resource type:
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">
|
||||
@ -647,7 +647,7 @@ 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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.</code><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">vm_tag=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">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
|
||||
@ -685,7 +685,7 @@ as technical preview. It may be changed in a future release.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.</code><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">vm_tag=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">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
|
||||
@ -730,7 +730,7 @@ be an identifier for the resource type:
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.vcenter.compute.policies package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -202,7 +202,7 @@
|
||||
classes for compute policy capabilities offered by vCenter.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.compute.policies.capabilities_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.compute.policies.capabilities_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.vcenter.deployment package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -202,7 +202,7 @@
|
||||
<span id="com-vmware-vcenter-deployment-install-client-module"></span><h2>com.vmware.vcenter.deployment.install_client module<a class="headerlink" href="#module-com.vmware.vcenter.deployment.install_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.deployment.install_client.RemotePsc">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.deployment.install_client.</code><code class="descname">RemotePsc</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install_client.RemotePsc" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment.install_client.</code><code class="sig-name descname">RemotePsc</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install_client.RemotePsc" 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">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
|
||||
@ -214,7 +214,7 @@ API 6.7.</p>
|
||||
</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>
|
||||
<code class="sig-name descname">check</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -253,7 +253,7 @@ if the appliance is not in INITIALIZED state.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.deployment.install_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment.install_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.vcenter.deployment.install package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -196,7 +196,7 @@
|
||||
<span id="com-vmware-vcenter-deployment-install-psc-client-module"></span><h2>com.vmware.vcenter.deployment.install.psc_client module<a class="headerlink" href="#module-com.vmware.vcenter.deployment.install.psc_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.deployment.install.psc_client.Replicated">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.deployment.install.psc_client.</code><code class="descname">Replicated</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install.psc_client.Replicated" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment.install.psc_client.</code><code class="sig-name descname">Replicated</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install.psc_client.Replicated" 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">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
|
||||
@ -208,7 +208,7 @@ vSphere API 6.7.</p>
|
||||
</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>
|
||||
<code class="sig-name descname">check</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
@ -246,7 +246,7 @@ if the appliance is not in INITIALIZED state.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.deployment.install.psc_client.Standalone">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.deployment.install.psc_client.</code><code class="descname">Standalone</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install.psc_client.Standalone" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment.install.psc_client.</code><code class="sig-name descname">Standalone</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment.install.psc_client.Standalone" 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">Standalone</span></code> class provides methods to check if the values provided
|
||||
for the standalone PSC satisfies the requirements. This class was added in
|
||||
@ -258,7 +258,7 @@ vSphere API 6.7.</p>
|
||||
</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>
|
||||
<code class="sig-name descname">check</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
@ -291,7 +291,7 @@ if the appliance is not in INITIALIZED state.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.deployment.install.psc_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment.install.psc_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.vcenter.deployment.install.initial_config package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,7 +186,7 @@
|
||||
<span id="com-vmware-vcenter-deployment-install-initial-config-remote-psc-client-module"></span><h2>com.vmware.vcenter.deployment.install.initial_config.remote_psc_client module<a class="headerlink" href="#module-com.vmware.vcenter.deployment.install.initial_config.remote_psc_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
@ -198,7 +198,7 @@
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.Thumbprint">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.</code><code class="sig-name descname">Thumbprint</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -209,7 +209,7 @@ remote PSC. This class was added in vSphere API 6.7.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">RemoteSpec</code><span class="sig-paren">(</span><em class="sig-param">address=None</em>, <em class="sig-param">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>
|
||||
@ -233,7 +233,7 @@ If None, port 443 will be used.</p></li>
|
||||
|
||||
<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>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
|
||||
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.7 documentation</title>
|
||||
<title>com.vmware.vcenter.hvc package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -194,7 +194,7 @@
|
||||
<span id="com-vmware-vcenter-hvc-links-client-module"></span><h2>com.vmware.vcenter.hvc.links_client module<a class="headerlink" href="#module-com.vmware.vcenter.hvc.links_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.links_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.links_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
@ -206,7 +206,7 @@
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.links_client.Sync">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.hvc.links_client.</code><code class="descname">Sync</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links_client.Sync" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.links_client.</code><code class="sig-name descname">Sync</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links_client.Sync" 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">Sync</span></code> class provides methods to create a sync session, get
|
||||
information on Sync. <strong>Warning:</strong> This class is available as technical
|
||||
@ -218,7 +218,7 @@ preview. It may be changed in a future release.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">Credentials</code><span class="sig-paren">(</span><em class="sig-param">user_name=None</em>, <em class="sig-param">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
|
||||
@ -243,7 +243,7 @@ technical preview. It may be changed in a future release.</p></li>
|
||||
|
||||
<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>
|
||||
<code class="sig-name descname">reset</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dd><p>Resets the sync state between the linked domains by initiating a fresh
|
||||
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.
|
||||
@ -276,7 +276,7 @@ if the user is not authorized to perform this operation.</p>
|
||||
<span id="com-vmware-vcenter-hvc-management-client-module"></span><h2>com.vmware.vcenter.hvc.management_client module<a class="headerlink" href="#module-com.vmware.vcenter.hvc.management_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.management_client.Administrators">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.hvc.management_client.</code><code class="descname">Administrators</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.management_client.</code><code class="sig-name descname">Administrators</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators" 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">Administrators</span></code> provides methods to update, delete, and list groups
|
||||
in the local sso group. This is limited to the Hybrid Linked Mode service.
|
||||
@ -289,7 +289,7 @@ changed in a future release.</p>
|
||||
</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>
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
@ -310,7 +310,7 @@ if the system reports an error while responding to the request.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.hvc.management_client.Administrators.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.get" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
@ -330,7 +330,7 @@ if the system reports an error while responding to the request.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.hvc.management_client.Administrators.remove">
|
||||
<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>
|
||||
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
@ -351,7 +351,7 @@ if the system reports an error while responding to the request.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.hvc.management_client.Administrators.set">
|
||||
<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>
|
||||
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
@ -374,7 +374,7 @@ if the system reports an error while responding to the request.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.management_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.management_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.vcenter.hvc.links package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -184,7 +184,7 @@
|
||||
<span id="com-vmware-vcenter-hvc-links-sync-client-module"></span><h2>com.vmware.vcenter.hvc.links.sync_client module<a class="headerlink" href="#module-com.vmware.vcenter.hvc.links.sync_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.hvc.links.sync_client.</code><code class="descname">Providers</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.links.sync_client.</code><code class="sig-name descname">Providers</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers" 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">Providers</span></code> class provides methods to create a sync session, get
|
||||
information on Sync. <strong>Warning:</strong> This class is available as technical
|
||||
@ -196,7 +196,7 @@ preview. It may be changed in a future release.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">Credentials</code><span class="sig-paren">(</span><em class="sig-param">user_name=None</em>, <em class="sig-param">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
|
||||
@ -221,7 +221,7 @@ technical preview. It may be changed in a future release.</p></li>
|
||||
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">last_sync_time=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">polling_interval_in_seconds=None</em>, <em class="sig-param">current_session_info=None</em>, <em class="sig-param">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>
|
||||
<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.Info</span></code> class contains information about sync for a
|
||||
provider. <strong>Warning:</strong> This class is available as technical preview. It may
|
||||
@ -262,14 +262,14 @@ of <code class="docutils literal notranslate"><span class="pre">status</span></c
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.RESOURCE_TYPE">
|
||||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vcenter.hvc.links.sync.Providers'</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vcenter.hvc.links.sync.Providers'</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for Sync Providers. <strong>Warning:</strong> This class attribute is
|
||||
available as technical preview. It may be changed in a future release.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo">
|
||||
<em class="property">class </em><code class="descname">SessionInfo</code><span class="sig-paren">(</span><em>stage=None</em>, <em>completed_work=None</em>, <em>total_work=None</em>, <em>completion_time=None</em>, <em>start_time=None</em>, <em>exception=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">SessionInfo</code><span class="sig-paren">(</span><em class="sig-param">stage=None</em>, <em class="sig-param">completed_work=None</em>, <em class="sig-param">total_work=None</em>, <em class="sig-param">completion_time=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">exception=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo" 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.SessionInfo</span></code> class contains sync session information.
|
||||
<strong>Warning:</strong> This class is available as technical preview. It may be
|
||||
@ -308,7 +308,7 @@ of <code class="docutils literal notranslate"><span class="pre">stage</span></co
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">Stage</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<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">Providers.SessionInfo.Stage</span></code> class defines the different stages of
|
||||
Sync. <strong>Warning:</strong> This enumeration is available as technical preview. It
|
||||
@ -330,7 +330,7 @@ type description page</span></a>.</p>
|
||||
</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>
|
||||
<code class="sig-name 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>
|
||||
<dd><p>Changes are being applied to the destination replica. <strong>Warning:</strong> This
|
||||
class attribute is available as technical preview. It may be changed in a
|
||||
future release.</p>
|
||||
@ -338,7 +338,7 @@ future release.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_DETECTION">
|
||||
<code class="descname">CHANGE_DETECTION</code><em class="property"> = Stage(string='CHANGE_DETECTION')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_DETECTION" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">CHANGE_DETECTION</code><em class="property"> = Stage(string='CHANGE_DETECTION')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_DETECTION" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Changes are being detected on the source replica. <strong>Warning:</strong> This class
|
||||
attribute is available as technical preview. It may be changed in a future
|
||||
release.</p>
|
||||
@ -346,7 +346,7 @@ release.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_ENUMERATION">
|
||||
<code class="descname">CHANGE_ENUMERATION</code><em class="property"> = Stage(string='CHANGE_ENUMERATION')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_ENUMERATION" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">CHANGE_ENUMERATION</code><em class="property"> = Stage(string='CHANGE_ENUMERATION')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_ENUMERATION" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Changes from the source replica are being enumerated. <strong>Warning:</strong> This
|
||||
class attribute is available as technical preview. It may be changed in a
|
||||
future release.</p>
|
||||
@ -354,21 +354,21 @@ future release.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.COMPLETED">
|
||||
<code class="descname">COMPLETED</code><em class="property"> = Stage(string='COMPLETED')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.COMPLETED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">COMPLETED</code><em class="property"> = Stage(string='COMPLETED')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.COMPLETED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sync has completed. <strong>Warning:</strong> This class attribute is available as
|
||||
technical preview. It may be changed in a future release.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED">
|
||||
<code class="descname">FAILED</code><em class="property"> = Stage(string='FAILED')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FAILED</code><em class="property"> = Stage(string='FAILED')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sync failed. <strong>Warning:</strong> This class attribute is available as technical
|
||||
preview. It may be changed in a future release.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.WAITING">
|
||||
<code class="descname">WAITING</code><em class="property"> = Stage(string='WAITING')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.WAITING" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">WAITING</code><em class="property"> = Stage(string='WAITING')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.WAITING" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Session is waiting for progress to be set. <strong>Warning:</strong> This class
|
||||
attribute is available as technical preview. It may be changed in a future
|
||||
release.</p>
|
||||
@ -380,7 +380,7 @@ release.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.Status">
|
||||
<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.hvc.links.sync_client.Providers.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.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>The <code class="docutils literal notranslate"><span class="pre">Providers.Status</span></code> class defines valid sync status. <strong>Warning:</strong> This
|
||||
enumeration is available as technical preview. It may be changed in a
|
||||
@ -402,21 +402,21 @@ type description page</span></a>.</p>
|
||||
</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>
|
||||
<code class="sig-name 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>
|
||||
<dd><p>If Sync failed. <strong>Warning:</strong> This class attribute is available as technical
|
||||
preview. It may be changed in a future release.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.Status.NO_SYNC_FOUND">
|
||||
<code class="descname">NO_SYNC_FOUND</code><em class="property"> = Status(string='NO_SYNC_FOUND')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.NO_SYNC_FOUND" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NO_SYNC_FOUND</code><em class="property"> = Status(string='NO_SYNC_FOUND')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.NO_SYNC_FOUND" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>If Sync has not been triggered. <strong>Warning:</strong> This class attribute is
|
||||
available as technical preview. It may be changed in a future release.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.Status.SUCCEEDED">
|
||||
<code class="descname">SUCCEEDED</code><em class="property"> = Status(string='SUCCEEDED')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.SUCCEEDED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">SUCCEEDED</code><em class="property"> = Status(string='SUCCEEDED')</em><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.SUCCEEDED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>If Sync was successful. <strong>Warning:</strong> This class attribute is available as
|
||||
technical preview. It may be changed in a future release.</p>
|
||||
</dd></dl>
|
||||
@ -425,7 +425,7 @@ technical preview. It may be changed in a future release.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.Summary">
|
||||
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>provider=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">provider=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.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">Providers.Summary</span></code> class contains information about a provider.
|
||||
<strong>Warning:</strong> This class is available as technical preview. It may be
|
||||
@ -451,7 +451,7 @@ be an identifier for the resource type:
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.get">
|
||||
<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>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">link</em>, <em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
@ -488,7 +488,7 @@ if the user is not authorized to perform this operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.list">
|
||||
<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>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
@ -516,7 +516,7 @@ If the user is not authorized to perform this operation.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.Providers.start">
|
||||
<code class="descname">start</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.start" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">start</code><span class="sig-paren">(</span><em class="sig-param">link</em>, <em class="sig-param">provider</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links.sync_client.Providers.start" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
@ -555,7 +555,7 @@ if a sync is already running.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.hvc.links.sync_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.links.sync_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.vcenter.storage package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -194,7 +194,7 @@
|
||||
<span id="com-vmware-vcenter-storage-policies-client-module"></span><h2>com.vmware.vcenter.storage.policies_client module<a class="headerlink" href="#module-com.vmware.vcenter.storage.policies_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.Compliance">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.storage.policies_client.</code><code class="descname">Compliance</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.storage.policies_client.</code><code class="sig-name descname">Compliance</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance" 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 Compliance class provides methods related to all the associated
|
||||
entities of given compliance statuses. This class was added in vSphere API
|
||||
@ -206,7 +206,7 @@ entities of given compliance statuses. This class was added in vSphere API
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">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>).
|
||||
@ -226,7 +226,7 @@ filter. This attribute was added in vSphere API 6.7.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.Compliance.Status">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -247,20 +247,20 @@ type description page</span></a>.</p>
|
||||
</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>
|
||||
<code class="sig-name 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></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>
|
||||
<code class="sig-name 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>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.Compliance.Status.NOT_APPLICABLE">
|
||||
<code class="descname">NOT_APPLICABLE</code><em class="property"> = Status(string='NOT_APPLICABLE')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status.NOT_APPLICABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NOT_APPLICABLE</code><em class="property"> = Status(string='NOT_APPLICABLE')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies_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 requirement that apply to the object-based datastore
|
||||
on which the entity is placed. This class attribute was added in vSphere
|
||||
@ -269,7 +269,7 @@ API 6.7.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.Compliance.Status.OUT_OF_DATE">
|
||||
<code class="descname">OUT_OF_DATE</code><em class="property"> = Status(string='OUT_OF_DATE')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status.OUT_OF_DATE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">OUT_OF_DATE</code><em class="property"> = Status(string='OUT_OF_DATE')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance.Status.OUT_OF_DATE" title="Permalink to this definition">¶</a></dt>
|
||||
<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
|
||||
@ -278,7 +278,7 @@ was added in vSphere API 6.7.</p>
|
||||
|
||||
<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>
|
||||
<code class="sig-name 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>
|
||||
</dd></dl>
|
||||
@ -287,7 +287,7 @@ added in vSphere API 6.7.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.Compliance.Summary">
|
||||
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>vm=None</em>, <em>vm_home=None</em>, <em>disks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">vm=None</em>, <em class="sig-param">vm_home=None</em>, <em class="sig-param">disks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies_client.Compliance.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>Provides the details of a virtual machine and its associated entities which
|
||||
match the given compliance statuses. This class was added in vSphere API
|
||||
@ -327,7 +327,7 @@ its disks are not associated with a storage policy.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.Compliance.list">
|
||||
<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>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -372,7 +372,7 @@ if the user doesn’t have the required privileges.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.storage.policies_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
@ -384,7 +384,7 @@ if the user doesn’t have the required privileges.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.VM">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.storage.policies_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_client.VM" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.storage.policies_client.</code><code class="sig-name descname">VM</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies_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 managing the storage policy association
|
||||
for a virtual machine and its virtual disks. This class was added in
|
||||
@ -396,7 +396,7 @@ vSphere API 6.7.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">vm_home=None</em>, <em class="sig-param">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
|
||||
@ -427,7 +427,7 @@ identifiers for the resource type:
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.storage.policies_client.VM.list">
|
||||
<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>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
|
||||
@ -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.7 documentation</title>
|
||||
<title>com.vmware.vcenter.storage.policies package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -184,7 +184,7 @@
|
||||
<span id="com-vmware-vcenter-storage-policies-compliance-client-module"></span><h2>com.vmware.vcenter.storage.policies.compliance_client module<a class="headerlink" href="#module-com.vmware.vcenter.storage.policies.compliance_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.storage.policies.compliance_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.storage.policies.compliance_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
@ -196,7 +196,7 @@
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.storage.policies.compliance_client.VM">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.storage.policies.compliance_client.</code><code class="sig-name descname">VM</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
@ -207,7 +207,7 @@ given compliance statuses. This class was added in vSphere API 6.7.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">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
|
||||
@ -239,7 +239,7 @@ filter</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.storage.policies.compliance_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.compliance_client.VM.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">vm_home=None</em>, <em class="sig-param">disks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies.compliance_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>Provides the compliance details of a virtual machine and its associated
|
||||
entities which match the given compliance statuses. This class was added in
|
||||
@ -273,7 +273,7 @@ a value of this class as a return value, the key in the attribute
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.storage.policies.compliance_client.VM.Status">
|
||||
<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.compliance_client.VM.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.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>The {\@Status} class defines he valid compliance status values for a
|
||||
virtual machine or virtual disk. This enumeration was added in vSphere API
|
||||
@ -295,21 +295,21 @@ type description page</span></a>.</p>
|
||||
</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>
|
||||
<code class="sig-name 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>
|
||||
</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>
|
||||
<code class="sig-name 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>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.storage.policies.compliance_client.VM.Status.NOT_APPLICABLE">
|
||||
<code class="descname">NOT_APPLICABLE</code><em class="property"> = Status(string='NOT_APPLICABLE')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status.NOT_APPLICABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NOT_APPLICABLE</code><em class="property"> = Status(string='NOT_APPLICABLE')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status.NOT_APPLICABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<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
|
||||
@ -318,7 +318,7 @@ was added in vSphere API 6.7.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.storage.policies.compliance_client.VM.Status.OUT_OF_DATE">
|
||||
<code class="descname">OUT_OF_DATE</code><em class="property"> = Status(string='OUT_OF_DATE')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status.OUT_OF_DATE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">OUT_OF_DATE</code><em class="property"> = Status(string='OUT_OF_DATE')</em><a class="headerlink" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.Status.OUT_OF_DATE" title="Permalink to this definition">¶</a></dt>
|
||||
<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
|
||||
@ -327,7 +327,7 @@ attribute was added in vSphere API 6.7.</p>
|
||||
|
||||
<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>
|
||||
<code class="sig-name 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>
|
||||
</dd></dl>
|
||||
@ -336,7 +336,7 @@ class attribute was added in vSphere API 6.7.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.storage.policies.compliance_client.VM.list">
|
||||
<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.compliance_client.VM.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">filter</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage.policies.compliance_client.VM.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns compliance information about at most 1000 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>. 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.
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<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>
|
||||
<title>com.vmware.vcenter.system_config.features package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -187,7 +187,7 @@ 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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.system_config.features.tech_preview_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<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>
|
||||
<title>com.vmware.vcenter.system_config package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.vcha package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
<title>com.vmware.vcenter.vcha package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -185,7 +185,7 @@ redeploying and monitoring a vCenter High Availability (VCHA) Cluster after a
|
||||
successful initial deployment.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Active">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="descname">Active</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Active" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="sig-name descname">Active</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Active" 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">Active</span></code> class provides methods to get information related to the
|
||||
active vCenter High Availability (VCHA) node. This class was added in
|
||||
@ -197,7 +197,7 @@ vSphere API 6.7.1.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Active.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>management=None</em>, <em>ha=None</em>, <em>placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Active.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">management=None</em>, <em class="sig-param">ha=None</em>, <em class="sig-param">placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Active.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">Active.Info</span></code> class contains the network and placement information of
|
||||
the active node of a VCHA Cluster. This class was added in vSphere API
|
||||
@ -227,7 +227,7 @@ active node should not be included.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Active.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>vc_spec=None</em>, <em>partial=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Active.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">vc_spec=None</em>, <em class="sig-param">partial=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Active.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves information about the active node of a VCHA cluster. This
|
||||
method was added in vSphere API 6.7.1.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -301,7 +301,7 @@ If any other error occurs.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="descname">DeploymentType</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="sig-name descname">DeploymentType</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType" 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 DeploymentType class provides methods to get the deployment type of a
|
||||
vCenter High Availability Cluster (VCHA Cluster). This class was added in
|
||||
@ -313,7 +313,7 @@ vSphere API 6.7.1.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>deployment_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">deployment_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.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">DeploymentType.Info</span></code> class contains the deployment type of the VCHA
|
||||
Cluster. This class was added in vSphere API 6.7.1.</p>
|
||||
@ -332,7 +332,7 @@ was added in vSphere API 6.7.1.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type">
|
||||
<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.vcenter.vcha.cluster_client.DeploymentType.Type" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.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">DeploymentType.Type</span></code> class defines the possible deployment types for
|
||||
a VCHA Cluster. This enumeration was added in vSphere API 6.7.1.</p>
|
||||
@ -353,21 +353,21 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.AUTO">
|
||||
<code class="descname">AUTO</code><em class="property"> = Type(string='AUTO')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.AUTO" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">AUTO</code><em class="property"> = Type(string='AUTO')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.AUTO" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>VCHA Cluster was deployed automatically. This class attribute was added in
|
||||
vSphere API 6.7.1.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.MANUAL">
|
||||
<code class="descname">MANUAL</code><em class="property"> = Type(string='MANUAL')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.MANUAL" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">MANUAL</code><em class="property"> = Type(string='MANUAL')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.MANUAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>VCHA Cluster was deployed manually. This class attribute was added in
|
||||
vSphere API 6.7.1.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.NONE">
|
||||
<code class="descname">NONE</code><em class="property"> = Type(string='NONE')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NONE</code><em class="property"> = Type(string='NONE')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>VCHA Cluster is not configured. This class attribute was added in vSphere
|
||||
API 6.7.1.</p>
|
||||
</dd></dl>
|
||||
@ -376,7 +376,7 @@ API 6.7.1.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves the deployment type of a VCHA cluster. This method was added
|
||||
in vSphere API 6.7.1.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -403,7 +403,7 @@ If any other error occurs.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="descname">Mode</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="sig-name descname">Mode</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode" 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 Mode class provides methods to manage the operating mode of a vCenter
|
||||
High Availability Cluster (VCHA Cluster). This class was added in vSphere
|
||||
@ -415,7 +415,7 @@ API 6.7.1.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode">
|
||||
<em class="property">class </em><code class="descname">ClusterMode</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">ClusterMode</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode" 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">Mode.ClusterMode</span></code> class defines the possible modes for a VCHA
|
||||
Cluster. This enumeration was added in vSphere API 6.7.1.</p>
|
||||
@ -436,7 +436,7 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.DISABLED">
|
||||
<code class="descname">DISABLED</code><em class="property"> = ClusterMode(string='DISABLED')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.DISABLED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">DISABLED</code><em class="property"> = ClusterMode(string='DISABLED')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.DISABLED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>VCHA Cluster is disabled. State replication between the Active and Passive
|
||||
node is disabled and automatic failover is not allowed. This class
|
||||
attribute was added in vSphere API 6.7.1.</p>
|
||||
@ -444,7 +444,7 @@ attribute was added in vSphere API 6.7.1.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.ENABLED">
|
||||
<code class="descname">ENABLED</code><em class="property"> = ClusterMode(string='ENABLED')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.ENABLED" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">ENABLED</code><em class="property"> = ClusterMode(string='ENABLED')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.ENABLED" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>VCHA Cluster is enabled. State replication between the Active and Passive
|
||||
node is enabled and automatic failover is allowed. This class attribute was
|
||||
added in vSphere API 6.7.1.</p>
|
||||
@ -452,7 +452,7 @@ added in vSphere API 6.7.1.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.MAINTENANCE">
|
||||
<code class="descname">MAINTENANCE</code><em class="property"> = ClusterMode(string='MAINTENANCE')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.MAINTENANCE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">MAINTENANCE</code><em class="property"> = ClusterMode(string='MAINTENANCE')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.MAINTENANCE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>VCHA Cluster is in maintenance mode. State replication between the and
|
||||
Passive node is enabled but automatic failover is not allowed. This class
|
||||
attribute was added in vSphere API 6.7.1.</p>
|
||||
@ -462,7 +462,7 @@ attribute was added in vSphere API 6.7.1.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>mode=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">mode=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.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">Mode.Info</span></code> class contains the mode of the VCHA Cluster. This class
|
||||
was added in vSphere API 6.7.1.</p>
|
||||
@ -481,7 +481,7 @@ in vSphere API 6.7.1.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves the current mode of a VCHA cluster. This method was added in
|
||||
vSphere API 6.7.1.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -509,7 +509,7 @@ If any other error occurs.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.set_task">
|
||||
<code class="descname">set_task</code><span class="sig-paren">(</span><em>mode</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.set_task" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">set_task</code><span class="sig-paren">(</span><em class="sig-param">mode</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.set_task" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Manipulates the mode of a VCHA Cluster. Following mode transitions are
|
||||
allowed:</p>
|
||||
<blockquote>
|
||||
@ -546,7 +546,7 @@ If any other error occurs.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Passive">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="descname">Passive</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="sig-name descname">Passive</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive" 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">Passive</span></code> class provides methods to validate a passive’s placement
|
||||
configuration and redeploy the passive node in a vCenter High Availability
|
||||
@ -558,7 +558,7 @@ configuration and redeploy the passive node in a vCenter High Availability
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Passive.CheckResult">
|
||||
<em class="property">class </em><code class="descname">CheckResult</code><span class="sig-paren">(</span><em>warnings=None</em>, <em>errors=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.CheckResult" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CheckResult</code><span class="sig-paren">(</span><em class="sig-param">warnings=None</em>, <em class="sig-param">errors=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.CheckResult" 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">Passive.CheckResult</span></code> class contains the warnings and errors that
|
||||
will occur during the clone operation. This class was added in vSphere API
|
||||
@ -582,7 +582,7 @@ operation will fail. This attribute was added in vSphere API 6.7.1.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Passive.CheckSpec">
|
||||
<em class="property">class </em><code class="descname">CheckSpec</code><span class="sig-paren">(</span><em>vc_spec=None</em>, <em>placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.CheckSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CheckSpec</code><span class="sig-paren">(</span><em class="sig-param">vc_spec=None</em>, <em class="sig-param">placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.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">Passive.CheckSpec</span></code> class contains placement information for
|
||||
validation. This class was added in vSphere API 6.7.1.</p>
|
||||
@ -608,7 +608,7 @@ attribute was added in vSphere API 6.7.1.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Passive.RedeploySpec">
|
||||
<em class="property">class </em><code class="descname">RedeploySpec</code><span class="sig-paren">(</span><em>vc_spec=None</em>, <em>placement=None</em>, <em>ha_ip=None</em>, <em>failover_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.RedeploySpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">RedeploySpec</code><span class="sig-paren">(</span><em class="sig-param">vc_spec=None</em>, <em class="sig-param">placement=None</em>, <em class="sig-param">ha_ip=None</em>, <em class="sig-param">failover_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.RedeploySpec" 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">Passive.RedeploySpec</span></code> class contains the redeploy specification.
|
||||
This class was added in vSphere API 6.7.1.</p>
|
||||
@ -645,7 +645,7 @@ assumed.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Passive.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.vcha.cluster_client.Passive.check" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">check</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Validates the specified passive node’s placement configuration. This
|
||||
method was added in vSphere API 6.7.1.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -705,7 +705,7 @@ If any other error occurs.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Passive.redeploy_task">
|
||||
<code class="descname">redeploy_task</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.redeploy_task" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">redeploy_task</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.redeploy_task" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates the passive node in a degraded cluster with node location
|
||||
information and pre-existing VCHA cluster configuration from the active
|
||||
node. This method was added in vSphere API 6.7.1.</p>
|
||||
@ -743,7 +743,7 @@ If any other error occurs.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vcha.cluster_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.vcha.cluster_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_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">
|
||||
@ -755,7 +755,7 @@ If any other error occurs.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Witness">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="descname">Witness</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="sig-name descname">Witness</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness" 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">Witness</span></code> class provides methods to validate a witness’s placement
|
||||
configuration and redeploy the witness node in a vCenter High Availability
|
||||
@ -767,7 +767,7 @@ configuration and redeploy the witness node in a vCenter High Availability
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Witness.CheckResult">
|
||||
<em class="property">class </em><code class="descname">CheckResult</code><span class="sig-paren">(</span><em>warnings=None</em>, <em>errors=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.CheckResult" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CheckResult</code><span class="sig-paren">(</span><em class="sig-param">warnings=None</em>, <em class="sig-param">errors=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.CheckResult" 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">Witness.CheckResult</span></code> class contains the warnings and errors that
|
||||
will occur during the clone operation. This class was added in vSphere API
|
||||
@ -791,7 +791,7 @@ operation will fail. This attribute was added in vSphere API 6.7.1.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Witness.CheckSpec">
|
||||
<em class="property">class </em><code class="descname">CheckSpec</code><span class="sig-paren">(</span><em>vc_spec=None</em>, <em>placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.CheckSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CheckSpec</code><span class="sig-paren">(</span><em class="sig-param">vc_spec=None</em>, <em class="sig-param">placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.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">Witness.CheckSpec</span></code> class contains placement information for
|
||||
validation. This class was added in vSphere API 6.7.1.</p>
|
||||
@ -817,7 +817,7 @@ attribute was added in vSphere API 6.7.1.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Witness.RedeploySpec">
|
||||
<em class="property">class </em><code class="descname">RedeploySpec</code><span class="sig-paren">(</span><em>vc_spec=None</em>, <em>placement=None</em>, <em>ha_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.RedeploySpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">RedeploySpec</code><span class="sig-paren">(</span><em class="sig-param">vc_spec=None</em>, <em class="sig-param">placement=None</em>, <em class="sig-param">ha_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.RedeploySpec" 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">Witness.RedeploySpec</span></code> class contains the redeploy specification.
|
||||
This class was added in vSphere API 6.7.1.</p>
|
||||
@ -849,7 +849,7 @@ network for the witness node will be used.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Witness.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.vcha.cluster_client.Witness.check" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">check</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Validates the specified witness node’s placement configuration. This
|
||||
method was added in vSphere API 6.7.1.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -909,7 +909,7 @@ If any other error occurs.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vcha.cluster_client.Witness.redeploy_task">
|
||||
<code class="descname">redeploy_task</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.redeploy_task" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">redeploy_task</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.redeploy_task" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates the witness node in a degraded cluster with node location
|
||||
information and pre-existing VCHA cluster configuration from the active
|
||||
node. This method was added in vSphere API 6.7.1.</p>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vcenter.vm.hardware package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||||
<title>com.vmware.vcenter.vm.hardware package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -190,7 +190,7 @@ conifguration of USB adapters and host bus adapters.</p>
|
||||
state, such as IDE and PCI adapters, are omitted.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware.adapter_client.</code><code class="descname">Sata</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware.adapter_client.</code><code class="sig-name descname">Sata</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata" 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">Sata</span></code> class provides methods for configuring the virtual SATA
|
||||
adapters of a virtual machine.</p>
|
||||
@ -201,7 +201,7 @@ adapters of a virtual machine.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec">
|
||||
<em class="property">class </em><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>type=None</em>, <em>bus=None</em>, <em>pci_slot_number=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">bus=None</em>, <em class="sig-param">pci_slot_number=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.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">Sata.CreateSpec</span></code> class provides a specification for the
|
||||
configuration of a newly-created virtual SATA adapter.</p>
|
||||
@ -228,7 +228,7 @@ virtual machine is powered on.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>label=None</em>, <em>type=None</em>, <em>bus=None</em>, <em>pci_slot_number=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">label=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">bus=None</em>, <em class="sig-param">pci_slot_number=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.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">Sata.Info</span></code> class contains information about a virtual SATA adapter.</p>
|
||||
<div class="admonition tip">
|
||||
@ -252,13 +252,13 @@ the adapter was created.</p></li>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.RESOURCE_TYPE">
|
||||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vcenter.vm.hardware.SataAdapter'</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vcenter.vm.hardware.SataAdapter'</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for the virtual SATA adapter device.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Summary">
|
||||
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>adapter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">adapter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.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">Sata.Summary</span></code> class contains commonly used information about a
|
||||
Virtual SATA adapter.</p>
|
||||
@ -282,7 +282,7 @@ identifier for the resource type:
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Type">
|
||||
<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.vcenter.vm.hardware.adapter_client.Sata.Type" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.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">Sata.Type</span></code> class defines the valid emulation types for a virtual
|
||||
SATA adapter.</p>
|
||||
@ -303,7 +303,7 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Type.AHCI">
|
||||
<code class="descname">AHCI</code><em class="property"> = Type(string='AHCI')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.Type.AHCI" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">AHCI</code><em class="property"> = Type(string='AHCI')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.Type.AHCI" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>AHCI host bus adapter.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -311,7 +311,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>vm</em>, <em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">vm</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a virtual SATA adapter to the virtual machine.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -392,7 +392,7 @@ guest-specific values.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>vm</em>, <em>adapter</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">vm</em>, <em class="sig-param">adapter</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Removes a virtual SATA adapter from the virtual machine.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -443,7 +443,7 @@ if the user doesn’t have the required privileges.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em>, <em>adapter</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">vm</em>, <em class="sig-param">adapter</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about a virtual SATA adapter.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -492,7 +492,7 @@ if the user doesn’t have the required privileges.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns commonly used information about the virtual SATA adapters
|
||||
belonging to the virtual machine.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -539,7 +539,7 @@ if the user doesn’t have the required privileges.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware.adapter_client.</code><code class="descname">Scsi</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware.adapter_client.</code><code class="sig-name descname">Scsi</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi" 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">Scsi</span></code> class provides methods for configuring the virtual SCSI
|
||||
adapters of a virtual machine.</p>
|
||||
@ -550,7 +550,7 @@ adapters of a virtual machine.</p>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.CreateSpec">
|
||||
<em class="property">class </em><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>type=None</em>, <em>bus=None</em>, <em>pci_slot_number=None</em>, <em>sharing=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">bus=None</em>, <em class="sig-param">pci_slot_number=None</em>, <em class="sig-param">sharing=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.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">Scsi.CreateSpec</span></code> class provides a specification for the
|
||||
configuration of a newly-created virtual SCSI adapter.</p>
|
||||
@ -581,7 +581,7 @@ If None, the adapter will default to <a class="reference internal" href="#com.vm
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>label=None</em>, <em>type=None</em>, <em>scsi=None</em>, <em>pci_slot_number=None</em>, <em>sharing=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">label=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">scsi=None</em>, <em class="sig-param">pci_slot_number=None</em>, <em class="sig-param">sharing=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.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">Scsi.Info</span></code> class contains information about a virtual SCSI adapter.</p>
|
||||
<div class="admonition tip">
|
||||
@ -608,13 +608,13 @@ the adapter was created.</p></li>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.RESOURCE_TYPE">
|
||||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vcenter.vm.hardware.ScsiAdapter'</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vcenter.vm.hardware.ScsiAdapter'</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resource type for the virtual SCSI adapter device.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing">
|
||||
<em class="property">class </em><code class="descname">Sharing</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Sharing</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing" 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">Scsi.Sharing</span></code> class defines the valid bus sharing modes for a
|
||||
virtual SCSI adapter.</p>
|
||||
@ -635,20 +635,20 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.NONE">
|
||||
<code class="descname">NONE</code><em class="property"> = Sharing(string='NONE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">NONE</code><em class="property"> = Sharing(string='NONE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.NONE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The virtual SCSI bus is not shared.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.PHYSICAL">
|
||||
<code class="descname">PHYSICAL</code><em class="property"> = Sharing(string='PHYSICAL')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.PHYSICAL" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">PHYSICAL</code><em class="property"> = Sharing(string='PHYSICAL')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.PHYSICAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The virtual SCSI bus is shared between two or more virtual machines
|
||||
residing on different physical hosts.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.VIRTUAL">
|
||||
<code class="descname">VIRTUAL</code><em class="property"> = Sharing(string='VIRTUAL')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.VIRTUAL" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">VIRTUAL</code><em class="property"> = Sharing(string='VIRTUAL')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.VIRTUAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The virtual SCSI bus is shared between two or more virtual machines. In
|
||||
this case, no physical machine is involved.</p>
|
||||
</dd></dl>
|
||||
@ -657,7 +657,7 @@ this case, no physical machine is involved.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Summary">
|
||||
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>adapter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Summary" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">adapter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.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">Scsi.Summary</span></code> class contains commonly used information about a
|
||||
Virtual SCSI adapter.</p>
|
||||
@ -681,7 +681,7 @@ identifier for the resource type:
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type">
|
||||
<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.vcenter.vm.hardware.adapter_client.Scsi.Type" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.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">Scsi.Type</span></code> class defines the valid emulation types for a virtual
|
||||
SCSI adapter.</p>
|
||||
@ -702,25 +702,25 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.BUSLOGIC">
|
||||
<code class="descname">BUSLOGIC</code><em class="property"> = Type(string='BUSLOGIC')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.BUSLOGIC" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">BUSLOGIC</code><em class="property"> = Type(string='BUSLOGIC')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.BUSLOGIC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>BusLogic host bus adapter.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.LSILOGIC">
|
||||
<code class="descname">LSILOGIC</code><em class="property"> = Type(string='LSILOGIC')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.LSILOGIC" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">LSILOGIC</code><em class="property"> = Type(string='LSILOGIC')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.LSILOGIC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>LSI Logic host bus adapter.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.LSILOGICSAS">
|
||||
<code class="descname">LSILOGICSAS</code><em class="property"> = Type(string='LSILOGICSAS')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.LSILOGICSAS" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">LSILOGICSAS</code><em class="property"> = Type(string='LSILOGICSAS')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.LSILOGICSAS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>LSI Logic SAS 1068 host bus adapter.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.PVSCSI">
|
||||
<code class="descname">PVSCSI</code><em class="property"> = Type(string='PVSCSI')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.PVSCSI" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">PVSCSI</code><em class="property"> = Type(string='PVSCSI')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.PVSCSI" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Paravirtualized host bus adapter.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -728,7 +728,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.UpdateSpec">
|
||||
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>sharing=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">sharing=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.UpdateSpec" 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">Scsi.UpdateSpec</span></code> class describes the updates to be made to the
|
||||
configuration of a virtual SCSI adapter.</p>
|
||||
@ -750,7 +750,7 @@ If None, the value is unchanged.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>vm</em>, <em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">vm</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a virtual SCSI adapter to the virtual machine.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -831,7 +831,7 @@ guest-specific values.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>vm</em>, <em>adapter</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">vm</em>, <em class="sig-param">adapter</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Removes a virtual SCSI adapter from the virtual machine.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -882,7 +882,7 @@ if the user doesn’t have the required privileges.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em>, <em>adapter</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">vm</em>, <em class="sig-param">adapter</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns information about a virtual SCSI adapter.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -931,7 +931,7 @@ if the user doesn’t have the required privileges.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.list" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns commonly used information about the virtual SCSI adapters
|
||||
belonging to the virtual machine.</p>
|
||||
<dl class="field-list simple">
|
||||
@ -976,7 +976,7 @@ if the user doesn’t have the required privileges.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>vm</em>, <em>adapter</em>, <em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.update" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">vm</em>, <em class="sig-param">adapter</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Updates the configuration of a virtual SCSI adapter.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
@ -1033,7 +1033,7 @@ if the user doesn’t have the required privileges.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware.adapter_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.hardware.adapter_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware.adapter_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_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">
|
||||
@ -1050,7 +1050,7 @@ if the user doesn’t have the required privileges.</p>
|
||||
managing the virtual devices used to boot a virtual machine.</p>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware.boot_client.</code><code class="descname">Device</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware.boot_client.</code><code class="sig-name descname">Device</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device" 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">Device</span></code> class provides methods for configuring the device order used
|
||||
when booting a virtual machine.</p>
|
||||
@ -1075,7 +1075,7 @@ multiple adapters may be specified in the boot order list.</p></li>
|
||||
</dl>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.Entry">
|
||||
<em class="property">class </em><code class="descname">Entry</code><span class="sig-paren">(</span><em>type=None</em>, <em>nic=None</em>, <em>disks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Entry" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Entry</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">nic=None</em>, <em class="sig-param">disks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Entry" 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">Device.Entry</span></code> class specifies a bootable virtual device class or
|
||||
specific bootable virtual device(s).</p>
|
||||
@ -1114,7 +1114,7 @@ of <code class="docutils literal notranslate"><span class="pre">type</span></cod
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.EntryCreateSpec">
|
||||
<em class="property">class </em><code class="descname">EntryCreateSpec</code><span class="sig-paren">(</span><em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.EntryCreateSpec" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">EntryCreateSpec</code><span class="sig-paren">(</span><em class="sig-param">type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.EntryCreateSpec" 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 class <code class="docutils literal notranslate"><span class="pre">Device.EntryCreateSpec</span></code> specifies a list of bootable virtual
|
||||
device classes. When a VM is being created and a <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of
|
||||
@ -1136,7 +1136,7 @@ names.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.Type">
|
||||
<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.vcenter.vm.hardware.boot_client.Device.Type" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.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">Device.Type</span></code> class defines the valid device types that may be used
|
||||
as bootable devices.</p>
|
||||
@ -1157,25 +1157,25 @@ type description page</span></a>.</p>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.CDROM">
|
||||
<code class="descname">CDROM</code><em class="property"> = Type(string='CDROM')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.CDROM" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">CDROM</code><em class="property"> = Type(string='CDROM')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.CDROM" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Virtual CD-ROM device.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.DISK">
|
||||
<code class="descname">DISK</code><em class="property"> = Type(string='DISK')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.DISK" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">DISK</code><em class="property"> = Type(string='DISK')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.DISK" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Virtual disk device.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET">
|
||||
<code class="descname">ETHERNET</code><em class="property"> = Type(string='ETHERNET')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">ETHERNET</code><em class="property"> = Type(string='ETHERNET')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Virtual Ethernet adapter.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.FLOPPY">
|
||||
<code class="descname">FLOPPY</code><em class="property"> = Type(string='FLOPPY')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.FLOPPY" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">FLOPPY</code><em class="property"> = Type(string='FLOPPY')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.FLOPPY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Virtual floppy drive.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -1183,7 +1183,7 @@ type description page</span></a>.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.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.hardware.boot_client.Device.get" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns an ordered list of boot devices for the virtual machine. If the
|
||||
<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> is empty, the virtual machine uses a default boot
|
||||
sequence.</p>
|
||||
@ -1229,7 +1229,7 @@ if the user doesn’t have the required privileges.</p>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.set">
|
||||
<code class="descname">set</code><span class="sig-paren">(</span><em>vm</em>, <em>devices</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.set" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">vm</em>, <em class="sig-param">devices</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the virtual devices that will be used to boot the virtual machine.
|
||||
The virtual machine will check the devices in order, attempting to boot
|
||||
from each, until the virtual machine boots successfully. If the
|
||||
@ -1291,7 +1291,7 @@ if the user doesn’t have the required privileges.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.hardware.boot_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware.boot_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.hardware.boot_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware.boot_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_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">
|
||||
|
||||
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.7 documentation</title>
|
||||
<title>com.vmware.vcenter.vm.storage package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -35,7 +35,7 @@
|
||||
<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 package" href="vmware.html" />
|
||||
<link rel="next" title="com.vmware.vcenter.vm_template package" href="com.vmware.vcenter.vm_template.html" />
|
||||
<link rel="prev" title="com.vmware.vcenter.vm.hardware package" href="com.vmware.vcenter.vm.hardware.html" />
|
||||
</head>
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
6.8.7
|
||||
6.9.1
|
||||
</div>
|
||||
|
||||
|
||||
@ -184,7 +184,7 @@
|
||||
<span id="com-vmware-vcenter-vm-storage-policy-client-module"></span><h2>com.vmware.vcenter.vm.storage.policy_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm.storage.policy_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.Compliance">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.storage.policy_client.</code><code class="descname">Compliance</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.storage.policy_client.</code><code class="sig-name descname">Compliance</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance" 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 Compliance class provides methods that return the compliance status of
|
||||
virtual machine entities(virtual machine home directory and virtual disks)
|
||||
@ -197,7 +197,7 @@ API 6.7.</p>
|
||||
</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>
|
||||
<em class="property">class </em><code class="sig-name descname">CheckSpec</code><span class="sig-paren">(</span><em class="sig-param">vm_home=None</em>, <em class="sig-param">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.
|
||||
@ -230,7 +230,7 @@ disks.</p></li>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.Compliance.Info">
|
||||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>overall_compliance=None</em>, <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.Info" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">overall_compliance=None</em>, <em class="sig-param">vm_home=None</em>, <em class="sig-param">disks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.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">Compliance.Info</span></code> class contains information about the storage policy
|
||||
compliance of a virtual machine, including information about it’s home
|
||||
@ -267,7 +267,7 @@ a value of this class as a return value, the key in the attribute
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.Compliance.Status">
|
||||
<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.vm.storage.policy_client.Compliance.Status" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_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>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
|
||||
@ -289,20 +289,20 @@ type description page</span></a>.</p>
|
||||
</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>
|
||||
<code class="sig-name 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></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>
|
||||
<code class="sig-name 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>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.Compliance.Status.NOT_APPLICABLE">
|
||||
<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>
|
||||
<code class="sig-name 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>
|
||||
@ -310,7 +310,7 @@ is placed. This class attribute was added in vSphere API 6.7.</p>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.Compliance.Status.OUT_OF_DATE">
|
||||
<code class="descname">OUT_OF_DATE</code><em class="property"> = Status(string='OUT_OF_DATE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Status.OUT_OF_DATE" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">OUT_OF_DATE</code><em class="property"> = Status(string='OUT_OF_DATE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.Status.OUT_OF_DATE" title="Permalink to this definition">¶</a></dt>
|
||||
<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
|
||||
@ -319,7 +319,7 @@ attribute was added in vSphere API 6.7.</p>
|
||||
|
||||
<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>
|
||||
<code class="sig-name 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>
|
||||
</dd></dl>
|
||||
@ -328,7 +328,7 @@ added in vSphere API 6.7.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo">
|
||||
<em class="property">class </em><code class="descname">VmComplianceInfo</code><span class="sig-paren">(</span><em>status=None</em>, <em>check_time=None</em>, <em>policy=None</em>, <em>failure_cause=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-name descname">VmComplianceInfo</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">check_time=None</em>, <em class="sig-param">policy=None</em>, <em class="sig-param">failure_cause=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage.policy_client.Compliance.VmComplianceInfo" 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.VmComplianceInfo</span></code> class contains information about
|
||||
storage policy compliance associated with a virtual machine. This class was
|
||||
@ -367,7 +367,7 @@ retrieving compliance. This attribute was added in vSphere API 6.7.</p></li>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.Compliance.check">
|
||||
<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>
|
||||
<code class="sig-name descname">check</code><span class="sig-paren">(</span><em class="sig-param">vm</em>, <em class="sig-param">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>
|
||||
@ -417,7 +417,7 @@ if the user does not have the required privileges.</p>
|
||||
|
||||
<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>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">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>
|
||||
<dl class="field-list simple">
|
||||
@ -459,7 +459,7 @@ if the user does not have the required privileges.</p>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vcenter.vm.storage.policy_client.StubFactory">
|
||||
<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>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.storage.policy_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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>
|
||||
<dl class="field-list simple">
|
||||
@ -480,7 +480,7 @@ if the user does not have the required privileges.</p>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<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_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="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>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user